用途
github-workflow 是一套围绕 GitHub 官方命令行工具 gh CLI 的协作流程技能,目标是把 Issue 管理、Pull Request 创建与合并、代码评审、分支保护、标签与发布等日常操作从网页界面转移到终端,并配合自动化 CI/CD 门禁来提升交付速度与一致性。资料将其定位为现代软件协作的操作规范,强调减少上下文切换、以自动化和明确标准驱动交付。
主要能力
资料将流程分为四个步骤。
第一步:gh CLI 高频操作
给出了一组核心命令示例:
gh issue create --title "fix(db): handle connection pool timeout" --body "Details..."
gh issue develop 42 --checkout
gh pr create --fill --assignee @me --label "bug,backend"
gh pr checks
gh pr merge --squash --delete-branch
覆盖从创建 Issue、基于 Issue 拉出分支、自动填充提交信息创建 PR,到查看 CI 检查状态、以 squash 方式合并并删除分支的完整链路。
第二步:PR 描述与评审规范
要求 PR 描述包含四部分:问题背景与关联 Issue(如 Fixes #42)、技术方案要点、验证证据(测试输出或截图、终端录制)、生产事故时的回滚方案。评审评论建议使用 nit:、suggestion:、question:、blocking: 等前缀,并且提出阻塞性意见时必须给出具体代码片段或替代方案。
第三步:分支保护与自动化 CI 门禁
包括要求线性历史(强制 squash 或 rebase,禁止 merge commit)、合并前必须通过的状态检查(linter 与静态分析如 eslint、golangci-lint、ruff;单元测试及覆盖率阈值不低于 80%;密钥与代码安全扫描如 gitleaks、CodeQL),以及要求签名提交(git commit -S)。
第四步:语义化版本发布与变更日志自动化
使用语义化版本标签(vMAJOR.MINOR.PATCH),通过 gh release create v3.1.0 --generate-notes --title "Release v3.1.0" 按 PR 标签自动生成分类发布说明,并用 CLI 将编译产物、压缩包、SHA256SUMS 校验文件附加到发布中。
使用方式
资料提供了一份 PR 模板(.github/pull_request_template.md),结构为:Summary(关联 Issue 与 2—3 句变更说明)、Technical Changes(逐文件说明非显而易见的架构变更)、Verification & Testing(单测、lint 勾选项及手动验证命令输出)、Rollback Strategy(回滚方式,如 gh pr revert 或回滚部署提交)。
另附一个发布自动化示例:先用 gh pr list --state merged --milestone "Sprint 14" 查看已合并 PR,再创建语义化版本并自动生成说明,最后上传二进制与校验文件:
gh pr list --state merged --milestone "Sprint 14"
gh release create v1.4.0 --generate-notes --title "v1.4.0: Distributed Queue Support"
gh release upload v1.4.0 ./dist/engine-linux-amd64 ./dist/SHA256SUMS
资料称该示例在约 45 秒内完成带签名说明、二进制资产与校验和的发布,无需打开浏览器。
验证清单与反模式
验证清单包括:PR 描述关联跟踪 Issue 并含可复现测试输出;CI 强制 linter、类型检查与自动化测试通过;分支保护要求检查通过并采用 squash 合并;发布标签遵循语义化版本;所有发布二进制附带加密校验和。
应避免的反模式包括:巨型 PR(数千行 diff、涉及大量无关文件却要求快速评审)、绕过 CI(在检查失败或跳过的情况下合入主分支)、含糊提交信息(如“updates”“fix stuff”)。
适用场景与限制
适用于使用 GitHub 进行协作开发、希望以终端命令和自动化门禁规范 Issue、PR、评审与发布流程的工程团队或个人开发者。限制方面:该技能依赖 GitHub 官方 CLI gh 及 GitHub 平台本身的 Issue、PR、Actions、分支保护等功能;资料未说明对其他代码托管平台的兼容性,未提供安装步骤、版本要求、许可信息或收费信息;示例中的覆盖率阈值、扫描工具与签名要求属于推荐实践,是否启用需由团队自行配置。