返回全部 Skills

github-actions-docs

开发工具

当用户询问如何编写、解释、自定义、迁移、保护或排查 GitHub Actions 工作流、工作流语法、触发器、矩阵、运行器、可重用工作流、制品、缓存、机密、OIDC、部署、自定义操作或 Actions Runner Controller 时使用,尤其是当他们需要官方 GitHub 文档、精确链接或基于文档的 YAML 指导时。

115k

下载量

AI SkillHub 能力展示图

安装方式

命令行安装

在项目根目录执行以下命令,完成 Skill 安装。

npx bzskills add xixu-me/skills --skill github-actions-docs

skill.md

name: github-actions-docs
description: 当用户询问如何编写、解释、自定义、迁移、保护或排查 GitHub Actions 工作流、工作流语法、触发器、矩阵、运行器、可重用工作流、制品、缓存、机密、OIDC、部署、自定义操作或 Actions Runner Controller 时使用,尤其是当他们需要官方 GitHub 文档、精确链接或基于文档的 YAML 指导时。

GitHub Actions 相关问题很容易凭借过时的记忆回答。请使用此技能将答案锚定在官方 GitHub 文档中,返回最接近的权威页面,而不是泛泛的 CI/CD 建议。

何时使用

当请求涉及以下内容时使用此技能:

  • GitHub Actions 的概念、术语或产品边界
  • Workflow YAML、触发器、作业、矩阵、并发、变量、上下文或表达式
  • GitHub 托管的运行器、大型运行器、自托管运行器或 Actions Runner Controller
  • 制品、缓存、可复用工作流、工作流模板或自定义操作
  • Secrets、GITHUB_TOKEN、OpenID Connect、制品认证或安全的工作流模式
  • 环境、部署保护规则、部署历史或部署示例
  • 从 Jenkins、CircleCI、GitLab CI/CD、Travis CI、Azure Pipelines 或其他 CI 系统迁移
  • 当用户需要文档、语法指导或官方参考时排查工作流行为

不要将此技能用于:

  • 特定的失败 PR 检查、缺失的工作流日志或 CI 故障分类。请使用 gh-fix-ci
  • 常规的 GitHub 拉取请求、分支或仓库操作。请使用 github
  • CodeQL 特定的配置或代码扫描指导。请使用 codeql
  • Dependabot 配置、分组或依赖更新策略。请使用 dependabot

工作流程

1. 分类请求

在搜索前决定问题属于哪个类别:

  • 入门或教程
  • 工作流编写与语法
  • 运行器与执行环境
  • 安全与供应链
  • 部署与环境
  • 自定义操作与发布
  • 监控、日志与故障排除
  • 迁移

如果需要快速起点,加载 references/topic-map.md 并跳转到最接近的部分。

2. 首先搜索官方 GitHub 文档

  • docs.github.com 视为事实来源。
  • 优先选择 <https://docs.github.com/en/actions> 下的页面。
  • 使用用户的确切术语加上聚焦的 Actions 短语进行搜索,例如 workflow syntaxOIDCreusable workflowsself-hosted runners
  • 当有多个页面看似合理时,比较 2-3 个候选页面,选择最能直接回答用户问题的页面。

3. 在回答前打开最佳页面

  • 阅读最相关的页面,并在可行时阅读确切的部分。
  • 仅使用主题映射来缩小搜索范围或提供可能的起始页面。
  • 如果某个页面似乎已重命名、移动或不完整,请明确说明,并返回最接近的权威页面,而不是猜测。

4. 以文档为依据的指导进行回答

  • 从直接、通俗易懂的答案开始。
  • 包含确切的 GitHub 文档链接,而不仅仅是文档主页。
  • 仅当用户要求或文档页面需要示例时才提供 YAML 或分步示例。
  • 让任何推理明确。好的措辞:
  • 根据 GitHub 文档...
  • 推断:这很可能意味着...

回答结构

除非用户要求详细,否则使用紧凑结构:

  1. 直接答案
  2. 相关文档
  3. 仅当需要的示例 YAML 或步骤
  4. 仅当需要连接多个文档页面时的明确推理说明

保持引用靠近所支持的主张。

搜索与路由提示

  • 对于概念性问题,在深入参考页面之前优先选择概述或概念页面。
  • 对于语法问题,优先选择工作流语法、事件、上下文、变量或表达式参考页面。
  • 对于安全问题,优先选择 Secure useSecretsGITHUB_TOKENOpenID Connect 和制品认证文档。
  • 对于部署问题,在云特定示例之前优先选择环境和部署保护文档。
  • 对于迁移问题,首先选择迁移中心页面,然后选择特定平台的迁移指南。
  • 如果用户要求初学者指南,从教程或快速入门开始,而不是原始参考页面。

常见错误

  • 在未验证当前文档的情况下凭记忆回答
  • 当存在更具体的页面时,仅链接到 GitHub Actions 文档着陆页
  • 混淆可复用工作流和复合操作
  • 当 OIDC 是文档更完善的路径时,建议使用长期云凭证
  • 将仓库特定的 CI 调试视为文档问题,而应交给 gh-fix-ci
  • codeqldependabot 更合适时,让相邻领域吸收请求

捆绑参考

仅将 references/topic-map.md 作为可能的文档入口点的紧凑索引阅读。它故意不完整,绝不应取代实时的 GitHub 文档作为最终权威。