用途:为仓库脚手架一个 CI 检查,拒绝不符合 Conventional Commits 规范的 pull request 标题。当 squash 合并使用 PR 标题作为 commit subject 时,未校验的标题一旦合并即写入永久历史,因此该检查尤为重要。
主要能力:检测仓库是否处于“squash 合并且以 PR 标题作为提交信息”模式(squash_merge_commit_title 为 PR_TITLE 时,默认分支上 git log --oneline 会成为 PR 标题列表);检测是否已存在同类检查(搜索 action-semantic-pull-request 或 commitlint 工作流),若有则停止并报告,避免重复添加。
使用方式:把 assets/pr-title.yml 复制到 .github/workflows/pr-title.yml。模板按 commit SHA 固定 amannn/action-semantic-pull-request,权限为 pull-requests: read(最小权限),在 opened、edited、synchronize、reopened 时重跑,并带 merge_group 触发及 job 级 if: github.event_name == 'pull_request'( merge group 无 PR 标题,故跳过,跳过视为成功)。模板内含注释掉的 types、scopes 和 subjectPattern 示例供用户启用,requireScope: false。覆盖已有文件前需先展示 diff 并询问。
可用命令示例: REPO="$(gh repo view --json nameWithOwner --jq '.nameWithOwner')" gh api "repos/$REPO" --jq '.squash_merge_commit_title' grep -rl 'action-semantic-pull-request' .github/workflows/ 2>/dev/null
可选:如需校验本地 commit message,应使用 commit-msg 钩子(如 prek),而非 GitHub Actions 作业。将检查设为必选状态属 gh-bootstrap 职责,且需用户明确授权;设为必选前须说明 merge queue 影响:使用 merge queue 的分支会等待 merge_group 事件上的每个必选检查,缺少该触发器会导致队列等待后丢弃 PR、合并失败。验证方式:提交标题为“updated stuff”之类不合规的 PR,确认检查失败并报清晰错误,再改为 fix: correct typo 确认转绿。限制:不负责配置 squash-only 合并、不负责把检查名加入 ruleset 必选状态、不负责发布、不负责本地 pre-commit/commit-msg 钩子,这些分别属于 gh-bootstrap、release、prek。