SuperAPI AI 工具集

github-project-automation

部署与运维

查看项目

更新于 10-16 07:46

技能介绍

GitHub Project Automation 是一个面向 GitHub 仓库的自动化配置技能,状态为 Production Ready,最后更新于 2025-11-06。它不依赖额外工具,推荐使用 git 和 gh CLI。该技能提供一套经过生产验证的模板,用于快速搭建 CI/CD 工作流、Issue 模板、Dependabot 依赖更新和 CodeQL 安全扫描。

用途 该技能主要用于自动化 GitHub 仓库的初始化配置,帮助开发者在约 15 分钟内完成从工作流到安全扫描的标准化设置。它通过预验证的 YAML 模板减少配置错误,并覆盖多种项目框架。

主要能力

  • 提供 12 个生产测试的工作流模板,包括 ci-basic、ci-node、ci-python、ci-react、ci-cloudflare-workers、security-codeql 等。
  • 提供 Issue 模板(bug_report.yml、feature_request.yml)和 PR 模板(PULL_REQUEST_TEMPLATE.md)。
  • 提供 Dependabot 配置模板,支持 npm 和 github-actions 生态,包含每周调度、PR 数量限制、审查者分配等设置。
  • 提供 CodeQL 安全扫描工作流模板,包含必要的 security-events: write 权限和矩阵语言配置。
  • 内置对 18 类常见 GitHub Actions 错误的预防说明,如 YAML 缩进错误、缺少 run/uses 字段、Action 版本固定问题、密钥语法错误、矩阵策略错误、CodeQL 未在 Dependabot PR 上运行等。
  • 提供常用模式示例:多框架矩阵测试、条件部署、制品上传/下载。
  • 附带参考文档(references/)和脚本(scripts/,Phase 3 计划中)。

使用方式

  1. 选择与项目匹配的工作流模板,复制到 .github/workflows/ 目录。例如 React/Vite 项目使用 ci-react.yml,Node.js 库使用 ci-node.yml,Python 项目使用 ci-python.yml,Cloudflare Workers 使用 ci-cloudflare-workers.yml,基础项目使用 ci-basic.yml。
  2. 创建 .github/ISSUE_TEMPLATE 目录,复制 YAML 格式的 Issue 模板。
  3. 启用安全扫描:复制 security-codeql.yml 到 .github/workflows/codeql.yml,复制 dependabot.yml 到 .github/dependabot.yml。
  4. 如需部署,使用 gh secret set 配置密钥,并注意正确的密钥语法 ${{ secrets.NAME }}。
  5. 按项目需求自定义用户名、邮箱、CodeQL 语言矩阵、Dependabot 包管理器、部署 URL 等。
  6. 提交前使用 yamllint 验证 YAML,并先在功能分支测试工作流。

适用场景

  • 需要快速为 React/Vite、Node.js、Python、Cloudflare Workers 等项目搭建 CI/CD 的团队。
  • 希望标准化 Issue 和 PR 模板、提升问题报告质量的项目。
  • 需要启用 Dependabot 依赖更新和 CodeQL 安全扫描的仓库。
  • 希望避免常见 GitHub Actions 配置错误的开发者。

限制

  • 部分脚本(scripts/)和参考文档(references/)标注为 Phase 2 或 Phase 3,可能尚未提供。
  • Dependabot 每个生态最多同时打开 10 个 PR,这是 GitHub 的硬性限制。
  • CodeQL 对编译型语言需要额外构建步骤,否则无法分析。
  • Issue 模板使用 YAML 格式以支持必填字段验证,PR 模板仍为 Markdown(GitHub 限制)。
  • 具体收费、价格、平台支持范围等未在资料中提供。