关于 github-project
github-project 是面向开发者和维护者的 GitHub 仓库管理技能,提供操作脚本及分主题参考资料,涵盖分支保护、拉取请求、CI、安全与仓库工作流。
主要功能
- 01设置并验证分支保护
- 02诊断拉取请求合并问题
- 03检查 GitHub Actions 故障
- 04提供安全与规则集指引
- 05查阅仓库操作参考资料
适用场景
- 01创建仓库后配置分支保护
- 02排查无法合并的拉取请求
- 03调查失败的 GitHub Actions 运行
- 04检查安全与自动合并设置
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ netresearch/ github-project-skill --skill github-project安装后在 Claude Code 中输入/github-project确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
checkpoints.yamlassets/auto-merge-direct.yml.templateauto-merge-queue.yml.templateauto-merge.yml.templatebranch-protection.json.templatebug_report.md.templateCODEOWNERS.templateCONTRIBUTING.md.templatedependabot.yml.templatefeature_request.md.templatepr-quality.yml.templatePULL_REQUEST_TEMPLATE.md.templaterelease-labeler.yml.templaterenovate.json.templateSECURITY.md.templateevals/evals.jsonreferences/actionlint-guide.mdactions-upgrade-guide.mdagentic-workflows.mdai-reviewer-pushback.mdauto-merge-guide.mdbranch-migration.mdci-runner-capacity.mdcross-repo-references.mddependency-management.mdgh-cli-reference.mdmerge-strategy.mdmulti-repo-operations.mdno-editorializing.mdorg-security-settings.md详细介绍
GitHub 项目技能
适用场景
- 执行
gh repo create并推送后、创建首个 PR 前 — 必须运行:scripts/init-branch-protection.sh OWNER/REPO - 向外部仓库提交首个议题/PR — 提交前阅读
references/upstream-contributions.md - 添加工作流作业 — 陷阱 #6
- PR 无法合并 / 讨论串
- 自动合并失败(Dependabot/Renovate)
- 单人自动批准
- 分支保护、规则集
- GHA 失败
- 签名提交合并
- CodeQL
- Scorecard
- CODEOWNERS、模板、标签
- Fork PR 合并基准
快速诊断
PR 无法合并
gh pr view PR --repo OWNER/REPO \
--json mergeStateStatus,reviewDecision,mergeable,reviewThreads
单人维护者:卡在 REVIEW_REQUIRED
可使用 assets/pr-quality.yml.template(自动批准,required_approving_review_count >= 1),或使用 scripts/init-branch-protection.sh OWNER/REPO --solo(批准数为 0,保留对话解决要求)——references/auto-merge-guide.md 对两种方案进行了比较。
自动合并设置
需要 allow_auto_merge、pull_request_target、机器人检测和 gh pr merge --auto(references/auto-merge-guide.md)。
自动合并不起作用
gh pr view PR --repo OWNER/REPO --json autoMergeRequest --jq .autoMergeRequest
绕过规则的参与者:references/security-config.md。
GitHub Actions 失败
gh run list --repo OWNER/REPO --limit 5
gh run view RUN_ID --repo OWNER/REPO --log-failed
gh run rerun RUN_ID --repo OWNER/REPO
安全快速检查
gh api repos/OWNER/REPO/rules/branches/main
gh api repos/OWNER/REPO/branches/main/protection \
--jq '{rcr: .required_conversation_resolution.enabled, admins: .enforce_admins.enabled}'
gh api repos/OWNER/REPO/code-scanning/default-setup --jq '.state'
gh pr view PR --repo OWNER/REPO --json reviewThreads --jq '.reviewThreads'
合并策略问题
references/auto-merge-guide.md:签名提交变基、工作流文件 PR、Copilot 竞态。
调用组织级可复用工作流
规则:uses: netresearch/<repo>/.github/workflows/<name>.yml@main。绝不能使用提交哈希,也不能使用 @<sha> # main;第三方操作仍须固定到 SHA。此类行上的 CodeQL actions/unpinned-tag、zizmor 或 SonarCloud 发现应标记为无法修复并予以忽略,绝不能通过固定版本来修复。原因:references/reusable-workflow-security.md。
运行脚本
scripts/init-branch-protection.sh OWNER/REPO # baseline
scripts/init-branch-protection.sh OWNER/REPO --from-current-checks # after first CI
scripts/init-branch-protection.sh OWNER/REPO --merge-queue # then: org-standard queue
scripts/verify-github-project.sh /path/to/repository # local-checkout audit
不加评论
说明变更做了什么,而不是评价它有多好。
参考资料
| 主题 | 参考资料 |
|---|---|
| 仓库引导 | references/repo-bootstrap.md |
| 仓库文件布局 | references/repository-structure.md |
| 分支迁移 | references/branch-migration.md |
| 仓库退役、Packagist 弃用 | references/repo-retirement.md |
| Dependabot/Renovate | references/dependency-management.md |
| 自动批准 + 自动合并 | references/auto-merge-guide.md |
| 合并策略 | references/merge-strategy.md |
| 子议题 | references/sub-issues.md |
| 发布标签 | references/release-labeling.md |
| gh CLI 命令 | references/gh-cli-reference.md |
| 多语言 CI 检查清单 | references/repo-setup-guide.md |
| Scorecard、CodeQL、安全 | references/security-config.md |
| actionlint | references/actionlint-guide.md |
| Actions 升级、Node 运行时升级 | references/actions-upgrade-guide.md |
| 工作流 bash 陷阱 | references/workflow-bash-patterns.md |
| Runner 容量、并发组(schedule 与 push) | references/ci-runner-capacity.md |
| 不加评论 | references/no-editorializing.md |
| Fork 合并基准 | references/pr-commit-cleanup.md |
| 多仓库批量操作 | references/multi-repo-operations.md |
| 公共仓库的私有副本(镜像推送) | references/multi-repo-operations.md |
| 跨仓库引用、代码永久链接 | references/cross-repo-references.md |
| 外部仓库贡献 | references/upstream-contributions.md |
| 可复用工作流安全 | references/reusable-workflow-security.md |
| 可复用工作流陷阱 | references/reusable-workflow-pitfalls.md |
| 组织安全设置 | references/org-security-settings.md |
| 标签验证 | references/tag-validation.md |
| 对 AI 审查者的异议 | references/ai-reviewer-pushback.md |
| Agentic 工作流 | references/agentic-workflows.md |
| Pages + 数据采集器 | references/pages-and-collector-workflows.md |