杜府 3 лет назад
Родитель
Сommit
68d9463103

+ 5 - 5
.github/workflows/auto-deploy-demo.yml

@@ -1,11 +1,11 @@
-# 当分支 main 有 push 事件,并且此次 push 包含了 demo 目录下的文件时触发,使用 GitHub Actions自动构建 Demo 并部署到服务器(使用 ubuntu-latest),具体步骤如下:
-# 1. cd demo 安装 nodejs , python3 , pip
+# 当分支 main 有 push 事件,并且此次 push 包含了 demo 目录下的文件时触发,使用 GitHub Actions 自动构建 Demo 并部署到服务器(使用 ubuntu-latest),具体步骤如下:
+# 1. 安装 nodejs , python3 , pip
 # 2. pip 依次安装 aliyun-python-sdk-cdn , aliyun-python-sdk-core , logging
 # 3. 安装 pnpm
-# 4. 安装依赖 pnpm install
+# 4. cd demo 安装依赖 pnpm install
 # 5. 打包 npm run build
-# 6. 使用 appleboy/scp-action@master 和 GitHub Actions secrets 存储的 ALIYUN_HOST ALIYUN_PORT ALIYUN_USERNAME ALIYUN_PRIVATE_KEY 将 dist 目录下所有文件上传到服务器上 /usr/share/nginx/demo_stdf 目录下
-# 7. 执行 Refresh-auto.py 刷新CDN缓存
+# 6. 使用 appleboy/scp-action@master 将 demo/dist 目录下所有文件上传到服务器上 demo 目录下
+# 7. 执行 demo/Refresh-auto.py 刷新 CDN 缓存
 
 name: Auto deploy demo
 

+ 2 - 1
.github/workflows/auto-public-npm.yml

@@ -1,5 +1,6 @@
 # 当分支 main 有 push 事件并且此次 push 包含了 components 目录下的文件时,执行以下任务
-# 使用 GitHub Actions secrets 存储的 NPM_TOKEN 自动将本仓库 components 目录下的所有文件发布到 npm 上
+# cd components 目录下
+# 发布 stdf 到 npm
 
 name: Auto publish npm
 

+ 7 - 14
.github/workflows/auto-releases.yml

@@ -1,11 +1,4 @@
 # 当分支 main 有 push 事件,并且此次 push 包含了 components/package.json 文件时,执行以下任务
-# 读取 components/package.json 中的 version 字段,作为 Releases tag 和 Releases title
-# 读取仓库内的 /doc/guide/changelog.md 和 /doc/guide/changelog_en.md 的第一行内容,去除 ## 和空格,与 components/package.json 中的 version 字段比较
-# 如果不相同则此次不需要发布 Release,退出
-# 如果相同则继续往下执行
-# 读取仓库内的 /doc/guide/changelog.md 中前两个二级标题之间的内容,包含换行和空格
-# 读取仓库内的 /doc/guide/changelog_en.md 中第一个二级标题与第二个二级标题之间的内容,包含换行和空格
-# Set as the latest release 并发布本次 Release,body 为上一步的两个内容合并为一个字符串,中间使用 --- 分隔
 
 name: Auto releases
 
@@ -24,25 +17,25 @@ jobs:
             - name: Checkout
               uses: actions/checkout@v2
 
-            # 读取 components/package.json 中的 version 字段,作为 Releases tag 和 Releases title
+            # 1. 读取 components/package.json 中的 version 字段,作为 Releases tag 和 Releases title
             - name: Get version
               id: version
               run: |
                   echo version=$(cat components/package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[",]//g' | tr -d '[[:space:]]') >> $GITHUB_OUTPUT
 
-            # 读取仓库内的 /doc/guide/changelog.md 的第一行内容,去除 ## 和空格
+            # 2. 读取 doc/guide/changelog.md 的第一行内容,去除 ## 和空格
             - name: Get md_version
               id: md_version
               run: |
                   echo md_version=$(cat doc/guide/changelog.md | head -1 | sed 's/## //g' | tr -d '[[:space:]]') >> $GITHUB_OUTPUT
 
-            # 读取仓库内的 /doc/guide/changelog_en.md 的第一行内容,去除 ## 和空格
+            # 3. 读取 doc/guide/changelog_en.md 的第一行内容,去除 ## 和空格
             - name: Get md_version_en
               id: md_version_en
               run: |
                   echo md_version_en=$(cat doc/guide/changelog_en.md | head -1 | sed 's/## //g' | tr -d '[[:space:]]') >> $GITHUB_OUTPUT
 
-            # 比较 Get version 与 Get md_version 和 Get md_version_en 三者的输出内容,如果不相同则此次不需要发布 Release,退出
+            # 4. 比较 Get version 与 Get md_version 和 Get md_version_en 三者的输出内容,如果不相同则此次不需要发布 Release,退出
             - name: Check version
               run: |
                   if [[ ${{ steps.version.outputs.version }} != ${{ steps.md_version.outputs.md_version }} ]]; then
@@ -54,19 +47,19 @@ jobs:
                       exit 78
                   fi
 
-            # 读取仓库内的 /doc/guide/changelog.md 中前两个二级标题之间的内容,包含换行和空格
+            # 5. 读取 doc/guide/changelog.md 中前两个二级标题之间的内容,包含换行和空格
             - name: Get changelog
               id: changelog
               run: |
                   echo changelog=$(sed -n '1,/##/{/##/!p;}' doc/guide/changelog.md | sed '/^$/d') >> $GITHUB_OUTPUT
 
-            # 读取仓库内的 /doc/guide/changelog_en.md 中第一个二级标题与第二个二级标题之间的内容,包含换行和空格
+            # 6. 读取 doc/guide/changelog_en.md 中第一个二级标题与第二个二级标题之间的内容,包含换行和空格
             - name: Get changelog_en
               id: changelog_en
               run: |
                   echo changelog_en=$(sed -n '1,/##/{/##/!p;}' doc/guide/changelog_en.md | sed '/^$/d') >> $GITHUB_OUTPUT
 
-            # 作为 latest release 发布本次 Release,body 为 changelog 和 changelog_en 的合并内容,中间使用 --- 分隔
+            # 7. 作为 latest release 发布本次 Release,body 为 changelog 和 changelog_en 的合并内容,中间使用 --- 分隔
             - name: Release
               uses: actions/create-release@v1
               env:

+ 5 - 5
.github/workflows/auto-sync-demo.yml

@@ -1,4 +1,4 @@
-# 当分支 main 有 push 事件,并且此次 push 包含了 demo 目录下的文件时触发,使用 GitHub Actions
+# 当分支 main 有 push 事件,并且此次 push 包含了 demo 目录下的文件时触发,使用 GitHub Actions 执行
 
 name: Auto sync demo
 
@@ -16,7 +16,7 @@ jobs:
             - name: Checkout
               uses: actions/checkout@v2
 
-            # 1. clone 仓库 github.com/dufu1991/stdf,使用 secrets.STDF_GITHUB_TOKEN
+            # 1. clone 仓库 github.com/dufu1991/stdf
             - name: Clone stdf
               uses: actions/checkout@v3
               with:
@@ -24,13 +24,13 @@ jobs:
                   token: ${{ secrets.STDF_GITHUB_TOKEN }}
                   path: stdf
 
-            # 2. 读取 components/package.json 中的 version 字段,作为 Releases tag 和 Releases title
+            # 2. 读取 components/package.json 中的 version 字段,作为 stdf 的最新版本
             - name: Get version
               id: version
               run: |
                   echo version=$(cat components/package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[",]//g' | tr -d '[[:space:]]') >> $GITHUB_OUTPUT
 
-            # 3. cd 到 stdf 仓库的 demo 文件内,初始化本地仓库
+            # 3. cd 到 stdf/demo 文件内,初始化本地仓库
             #    将 demo/src/App.svelte 文件内的 ../../components 替换为 stdf
             #    将 demo/src/pages 目录下的所有子孙 .svelte 文件内的 ../../../../components 替换为 stdf
             #    将 demo/package.json 内的第 15 行增加内容为 stdf,版本号为 ${{ steps.version.outputs.version }}
@@ -47,7 +47,7 @@ jobs:
                   git add .
                   git commit -am "Github Actions auto commit: update demo from stdf."
 
-            # 4. 使用 secrets.GITHUB_TOKEN 将修改内容推送到 git@github.com:dufu1991/demo-stdf.git 的 main 分支
+            # 4. 将修改内容推送到 git@github.com:dufu1991/demo-stdf.git 的 main 分支
             - name: Push to demo-stdf
               uses: ad-m/github-push-action@master
               with: