feat: 增强CI流程，添加注释和项目信息打印，提高可读性和可维护性

Author: dushenyan

.github/workflows/ci.yml

@@ -1,66 +1,84 @@
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+# 用于构建和部署Jekyll站点到GitHub Pages的工作流程示例
+# 工作流程名称：使用预装GitHub Pages依赖项部署Jekyll
+name: 使用预装GitHub Pages依赖项部署Jekyll
 
+# 触发条件设置
 on:
-  # Runs on pushes targeting the default branch
+  # 当推送到默认分支时运行
   push:
     branches: ["main"]
 
-  # Allows you to run this workflow manually from the Actions tab
+  # 允许从Actions选项卡手动运行此工作流程
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+# 设置GITHUB_TOKEN的权限，允许部署到GitHub Pages
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+  contents: read   # 允许读取仓库内容
+  pages: write     # 允许写入GitHub Pages
+  id-token: write  # 允许写入ID令牌
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+# 并发控制设置：只允许一个部署同时进行
+# 跳过排队在正在进行的运行和最新排队的运行之间的运行
+# 但不要取消正在进行的运行，因为我们希望这些生产部署完成
 concurrency:
-  group: "pages"
-  cancel-in-progress: false
+  group: "pages"           # 并发组名称
+  cancel-in-progress: false # 是否取消正在进行的运行
 
+# 定义工作流程中的任务
 jobs:
-  # Build job
+  # 构建任务
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest  # 运行环境：最新的Ubuntu
     steps:
+      # 步骤1：检出代码
       - name: Checkout
         uses: actions/checkout@v4
+      
+      # 步骤2：设置GitHub Pages环境
       - name: Setup Pages
         uses: actions/configure-pages@v5
+      
+      # 步骤3：打印项目信息
       - name: Print Project Information
         run: |
-          echo "=========================================="
-          echo "Project: github-deploy"
-          echo "Description: 使用github为网站提供部署服务以及部署流进程运行"
-          echo "Website: https://dushenyan.github.io/github-deploy/"
-          echo "Repository: https://github.com/dushenyan/github-deploy"
-          echo "=========================================="
+          echo "======================"
+          echo "项目名称: github-deploy"
+          echo "项目描述: 使用github为网站提供部署服务以及部署流进程运行"
+          echo "网站地址: https://dushenyan.github.io/github-deploy/"
+          echo "仓库地址: https://github.com/dushenyan/github-deploy"
+          echo "======================="
+      
+      # 步骤4：使用Jekyll构建站点
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
-          source: ./
-          destination: ./_site
+          source: ./          # 源代码目录
+          destination: ./_site # 构建输出目录
+      
+      # 步骤5：上传构建产物
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
 
-  # Deployment job
+  # 部署任务
   deploy:
     environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
+      name: github-pages     # 环境名称
+      url: ${{ steps.deployment.outputs.page_url }}  # 部署后的页面URL
+    runs-on: ubuntu-latest   # 运行环境：最新的Ubuntu
+    needs: build             # 此任务依赖于build任务完成
+    
+    # 部署步骤
     steps:
+      # 步骤1：部署到GitHub Pages
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+      
+      # 步骤2：打印部署成功信息
       - name: Print Deployment Success Message
         run: |
-          echo "=========================================="
-          echo "Deployment completed successfully!"
-          echo "Project github-deploy is now live at: ${{ steps.deployment.outputs.page_url }}"
-          echo "Thank you for using GitHub Pages for deployment!"
-          echo "=========================================="
+          echo "======================"
+          echo "部署完成！"
+          echo "项目 github-deploy 现已上线: ${{ steps.deployment.outputs.page_url }}"
+          echo "感谢使用 GitHub Pages 部署服务！"
+          echo "======================"

README.md

@@ -6,9 +6,22 @@
 
 使用github为网站提供部署服务以及部署流进程运行
 
+保证项目仓库必须是**public**状态
+
+1. 开启github pages服务 
+![alt text](assets/image.png)
+
+action服务配置文件
+
+![alt text](assets/image-2.png)
+
+2. 调整部署目录
+![alt text](assets/image-1.png)
+
 ### 相关链接
 
 - [项目地址](https://github.com/dushenyan/github-deploy)
 - [feather SVG库](https://feathericons.com/)
+- [阮一峰的网络日志](https://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html)