mcpField
G
github-actions-docs

github-actions-docs

github.com/xixu-me云与 DevOps79513.1k 次安装3 天前更新
代码仓库

关于 github-actions-docs

github-actions-docs 是用于回答 GitHub Actions 问题的技能,以官方文档为依据,帮助用户查找工作流语法、运行器、安全和部署等主题的权威资料,并将 CI 故障排查引向其他技能。

主要功能

  1. 01按主题分类问题
  2. 02检索 GitHub 官方文档
  3. 03打开并核对相关页面
  4. 04提供具体文档链接
  5. 05区分相邻的排障主题

适用场景

  1. 01查找工作流 YAML 语法说明
  2. 02核对运行器与部署文档
  3. 03定位安全和密钥资料
  4. 04选择 CI 迁移问题的指南

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/xixu-me/skills --skill github-actions-docs

安装后在 Claude Code 中输入/github-actions-docs确认已加载。

附带文件references/topic-map.md

详细介绍

GitHub Actions 相关问题很容易凭过时记忆作答。使用此技能,依据 GitHub 官方文档提供可靠答案,并返回最权威且最贴切的页面,而不是泛泛而谈 CI/CD。

何时使用

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

  • GitHub Actions 概念、术语或产品边界
  • 工作流 YAML、触发器、作业、矩阵、并发、变量、上下文或表达式
  • GitHub 托管的运行器、更大型运行器、自托管运行器或 Actions Runner Controller
  • 构件、缓存、可复用工作流、工作流模板或自定义操作
  • 密钥、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 syntax、OIDC、reusable workflows 或 self-hosted runners。
  • 如果有多个可能相关的页面,请比较 2-3 个候选页面,选择最直接回答用户问题的页面。
3. 回答前打开最佳页面
  • 阅读最相关的页面;可行时,阅读确切的相关章节。
  • 仅使用主题映射来缩小搜索范围或查找可能的起始页面。
  • 如果页面似乎已更名、移动或内容不完整,请明确说明,并提供最接近的权威页面,而不是猜测。
4. 根据文档提供有依据的指导
  • 先用通俗语言直接回答。
  • 提供 GitHub 文档的确切链接,而不只是文档主页。
  • 只有在用户要求时,或文档页面需要示例时,才提供 YAML 或分步示例。
  • 明确标注推断。推荐表述:
    • 根据 GitHub 文档,……
    • 推断:这可能意味着……

回答格式

除非用户要求详细说明,否则采用简洁结构:

  1. 直接回答
  2. 相关文档
  3. 仅在需要时提供 YAML 示例或步骤
  4. 仅在需要结合多个文档页面时明确标注推断

将引用放在其支持的论述附近。

搜索与路由提示

  • 对于概念问题,优先选择概览或概念页面,而不是深入的参考页面。
  • 对于语法问题,优先选择工作流语法、事件、上下文、变量或表达式参考页面。
  • 对于安全问题,优先选择 Secure use、Secrets、GITHUB_TOKEN、OpenID Connect 和构件证明文档。
  • 对于部署问题,优先选择环境和部署保护文档,而不是特定云平台的示例。
  • 对于迁移问题,先查看迁移中心页面,再查看特定平台的迁移指南。
  • 如果用户要求面向初学者的操作指南,请从教程或快速入门开始,而不是直接使用参考页面。

常见错误

  • 未核对当前文档,仅凭记忆作答
  • 存在更具体的页面时,仍链接到 GitHub Actions 文档首页
  • 混淆可复用工作流和复合操作
  • OIDC 是文档中更推荐的方式时,仍建议使用长期有效的云凭证
  • 将特定仓库的 CI 调试当作文档问题处理,而不是转交给 gh-fix-ci
  • 请求更适合由 codeql 或 dependabot 处理时,却让相邻领域接手

随附参考

仅将 references/topic-map.md 作为可能的文档入口索引。它有意保持不完整,绝不能替代 GitHub 实时文档作为最终依据。

评论

支持 Markdown