GitHub

约 1550 字大约 5 分钟

GitHub Actions

GitHub Actions 是一个持续集成和持续交付 (CI/CD) 平台，可用于自动执行构建、测试和部署管道。您可以创建工作流程来构建和测试存储库的每个拉取请求，或将合并的拉取请求部署到生产环境。将 GitHub Actions 命令保存为 main.yml，放于 .github\workflows 目录下，repo 发生指定调节的改变时，Actions 会自动运行。^[1]

如果 GitHub Actions 命令中有涉及密码等私密信息，则进入项目仓库的「Settings」>「Secrets and variables」>「Actions」，添加密钥进行加密处理。比如新建密钥 PERSONAL_TOKEN，Actions 命令中使用 ${{ secrets.PERSONAL_TOKEN }} 来指代该密钥。

Dependabot

Dependabot 是 GitHub 提供的官方自动化工具，可监视项目中使用的依赖项中的漏洞，并确保这些依赖项保持最新。你可以使用常用 Dependabot 自动化中的 GitHub Actions 命令，使 Dependabot 自动完成依赖的标记、批准拉取请求以及合并操作。如果仍有疑问，可以参考 tools-by-ai 中的 .github 配置。

完成上述配置后，Actions 可能会报错 failed to create review: GraphQL: GitHub Actions is not permitted。这是由于 Actions 权限未开启的原因。我们需要继续进行以下设置：

进入项目仓库的「Settings」。
选择「General」>「Pull Requests」，勾选 Allow auto-merge，以赋予 Actions 合并操作权限。
在同一界面，选择「Code and automation」>「Actions」>「General」>「Workflow permissions」，选中 Read and write permissions，并勾选 Allow GitHub Actions to create and approve pull requests，然后点击保存。这样可以授予 Actions 批准拉取请求的权限。

注意：GitHub Free 账户只支持在公共仓库中使用自动标记、批准拉取请求以及合并操作。

不同仓库间复制

复制文件到目的地，文档没变化则不会执行。案例为将当前仓库 main 分支下 docs 的 README.md 文件复制到另一个仓库 rockbenben/LearnData/ 路径下，如果目标路径存在相同文件，则将覆盖。如果让 clean: true 生效，Actions 会将目标路径情况，然后执行复制。

此动作需按 Creating a personal access token 建立个人访问令牌，勾选权限「repo Full control of private repositories」，然后将该 token 值其保存在项目仓库的 Action 密钥。

- name: Copy file
  uses: andstor/copycat-action@v3
  with:
    personal_token: ${{ secrets.PERSONAL_TOKEN }}
    src_path: docs/README.md
    dst_path: /
    dst_owner: rockbenben
    dst_repo_name: LearnData
    dst_branch: main
    src_branch: main
    #clean: true

Actions 失败重试

在 job 和 step 中使用 if 语句，只有满足条件时才执行具体的 job 或 step。^[2]

# 任务状态检查函数
success() # 当上一步执行成功时返回 true
always() # 总是返回 true
cancelled() # 当 workflow 被取消时返回 true
failure() # 当上一步执行失败时返回 true

first_step 会总是执行，second_step 需要上一步 first_step 执行成功才会执行，third_step 只有上一步 second_step 执行失败才执行。当 third_step 与 second_step 命令相同时，就可以达到失败重试的效果了。

jobs:
  first_job:
    name: My first job
    runs-on: ubuntu-latest
    steps:
      - name: first_step
        if: always()

      - name: second_step
        if: success()

      - name: third_step
        if: failure()

uses 版本号

uses: SamKirkland/FTP-Deploy-Action@4.3.1：uses 会指定此步骤运行 SamKirkland/FTP-Deploy-Action 存储库中的 4.3.1 版本。

但有时 Actions 的版本不会这么快更新，又必须使用最新版，可以将版本号改为 branch name，比如 uses: SamKirkland/FTP-Deploy-Action@master。

Git Commit

标准化的 Commit message 可以提供清晰、易读的历史记录，使我们更容易理解每个提交的目的和内容，这有助于追踪和审查代码变更。通过 conventional-changelog-cli 可以自动生成 CHANGELOG.md。建议都按照 Conventional Commits 的规范来进行提交。

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Type

Type 用于说明 git commit 的类别，只允许使用下面的标识。^[3]

feat: 新特性或功能（feature）
fix: 修复 bug
docs: 文档更新（documentation）
style: 代码风格或者组件样式更新（不影响代码运行的变动）
refactor: 代码重构，不引入新功能和缺陷修复
perf: 优化相关，比如提升性能、体验
test: 增加测试
chore: 构建过程或辅助工具的变动
revert: 回滚到上一个版本

Scope

Scope 用于说明 commit 影响的范围，比如 Controller、DAO、View 等等，视项目不同而不同。如果其中包含了多个 scope，可以使用 * 代替。

如果当前代码与上一个版本不兼容，则 Footer 部分以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。^[4]

如果当前 commit 针对某个 issue，那么可以在 Footer 部分使用 Closes #265 关闭这个 issue。也可以在任意位置输入 #265，将 commit 与对应问题相关联。

yarn add strapi-google-auth
yarn add https://github.com/arjusmoon860/strapi-google-auth.git

GitHub

GitHub Actions

Dependabot

不同仓库间复制

Actions 失败重试

uses 版本号

Git Commit

Type

Scope

Footer

Pull Requests

常见问题

GitHub 忽略指定文件

添加 Github 源作为依赖