跳到正文
Code Review
← 规则库/工程与配置

评审检查清单

GitHub Workflows

工程与配置18 个检查项4 个章节
.github/workflows/**/*.{yaml,yml}
01

安全

6 项
  • GITHUB-WORKFLOWS-SECURITY-001状态加载中
    pull_request_target 误用:将 pull_request_target 与引用 PR head 代码的 actions/checkout 搭配使用很危险——它会以写权限运行不可信代码。若 checkout ref 在无隔离的情况下指向 PR head 则标记
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-SECURITY-002状态加载中
    Secrets 泄露:Secrets 不得输出到日志(例如 echo ${{ secrets.X }})。核实 secrets 仅通过 env: 块传递给需要它们的步骤
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-SECURITY-003状态加载中
    权限过大:检查 permissions 是否按最小权限设置。标记 permissions: write-all 或缺失 permissions 键(默认为宽泛权限)。每个 job 只应声明其所需的权限
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-SECURITY-004状态加载中
    action 版本未固定:第三方 action 应固定到完整 commit SHA(例如 uses: actions/checkout@<sha>),而非仅固定 tag。tag 可变且可能被劫持。第一方(actions/*)固定到 v4 是可接受的
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-SECURITY-005状态加载中
    脚本注入:诸如 ${{ github.event.issue.title }} 的表达式直接用于 run: 块会造成代码注入。必须改为通过环境变量传递
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-SECURITY-006状态加载中
    硬编码凭据:token、密码或 API key 直接写在 workflow 文件中(而非通过 secrets)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

02

正确性

6 项
  • GITHUB-WORKFLOWS-CORRECTNESS-001状态加载中
    缺失 fetch-depth: 0:当 workflow 需要 git 历史(tag、merge-base、changelog 生成)时,核实 actions/checkout 使用了 fetch-depth: 0
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-CORRECTNESS-002状态加载中
    条件逻辑错误:核实 if: 条件正确(例如 github.event_name == 'pull_request' 与 'pull_request_target' 之别);确保布尔表达式加了正确的引号
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-CORRECTNESS-003状态加载中
    matrix 策略缺口:检查 matrix 组合覆盖了所需的平台。若 fail-fast 为 true(默认值)但所有 matrix 分支都必须成功,则标记
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-CORRECTNESS-004状态加载中
    缺失 shell 指定:在 self-hosted runner 上用 run: 执行多行脚本时,应显式指定 shell(bash、sh 还是 pwsh)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-CORRECTNESS-005状态加载中
    job 依赖损坏:核实 needs: 引用是同一 workflow 中真实存在的 job ID。检查是否存在循环依赖
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-CORRECTNESS-006状态加载中
    action 输入拼写错误:action 输入名拼写错误(例如把 fetch-depth 写成 fetch-detph)会被静默忽略
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

03

可靠性

3 项
  • GITHUB-WORKFLOWS-RELIABILITY-001状态加载中
    缺失超时:没有 timeout-minutes 的 job 可能无限期运行并消耗 runner 资源。标记缺少超时的 job(尤其是 self-hosted runner 上)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-RELIABILITY-002状态加载中
    缺少并发控制:由 push/PR 触发且没有 concurrency 组的 workflow 可能产生冗余运行。在合适场景建议使用带 cancel-in-progress 的 concurrency
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-RELIABILITY-003状态加载中
    依赖未缓存:构建 workflow 每次运行都未加缓存地安装依赖(没有 actions/cache 或内置缓存)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

04

最佳实践

3 项
  • GITHUB-WORKFLOWS-BEST-PRACTICES-001状态加载中
    废弃特性:标记废弃语法的使用(set-output、save-state、::set-output,以及 v4 可用时的 actions/checkout@v2/v3)
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-BEST-PRACTICES-002状态加载中
    对 continue-on-error 缺少考虑:若某个步骤的失败不应导致整个 job 失败,需要 continue-on-error: true;反之,核实非关键步骤没有用 || true 静默吞掉失败、掩盖真实错误
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • GITHUB-WORKFLOWS-BEST-PRACTICES-003状态加载中
    容器镜像 tag:容器镜像使用 latest tag 不可靠;优先使用具体版本 tag
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

返回本页顶部 ↑继续浏览规则库

手动复制规则链接

浏览器未允许自动复制,请选中下方链接复制。