GitHub Docs 参考技能用于把 GitHub 官方文档(docs.github.com)的主要章节整理为可分步检索的参考文件结构,供 AI 代理按需查阅。它的定位不是自动化工具,而是文档导航与检索型技能。
【用途】 当用户的任务涉及 GitHub 平台的用法查询时,使用该技能定位到相应文档页面并读取详细内容。技能说明中明确的工作方式是:根据用户的 task 判断所属类别,先读取该类别目录下的 README.md 找到目标页面,再读取对应的 .md 文件确认细节。
【覆盖主题】 技能提供的内容范围与 GitHub 官方文档主要章节对应,包括:
- Actions:workflow 语法、事件触发、表达式、上下文、权限、secrets、缓存、artifacts、可复用工作流、runner,以及创建自定义 action(JavaScript、Docker、复合 action)。
- GitHub Apps:概述、认证、创建、安装、OAuth Apps 对比、权限与事件、webhooks。
- 认证:部署密钥、个人访问令牌(PAT)、SAML SSO、SSH 密钥、两步验证(2FA)。
- gh CLI:快速上手、命令参考、CLI 扩展。
- GraphQL:概述、构造调用、分页、速率限制、schema 参考。
- GitHub Pages:入门、配置、自定义域名。
- Projects(v2):REST / GraphQL API 操作。
- Pull Requests:创建、审查、合并、CODEOWNERS、冲突处理。
- 仓库:创建与管理、分支、文件、release 与 tag、设置、模板。
- REST API:总览(认证、版本、分页、权限、速率限制、最佳实践、排错),以及 actions、activity、checks、codespaces、copilot、deployments、gists、git、issues、orgs、packages、pages、projects、pulls、repos、search、security、users 等分组的接口文档。
- Webhooks:概述、创建、事件、安全、最佳实践。
- 示例(samples):ci-node、matrix-build、cache-dependencies、deploy-on-push、manual-dispatch、pr-auto-comment、rest-api-call、reusable-workflow-deploy、scheduled-workflow、secret-usage、composite-action 等工作流与调用示例。
- 脚本(scripts):install、auth、api、cli、extensions、generate。
【使用方式】
- 依据任务在映射表中找到对应类别(如 workflow 语法 → actions;GraphQL 查询 → graphql;REST 分页与限流 → rest-api/overview)。
- 读取该类别目录下的 README.md,确定目标页面。
- 读取目标页面的 .md 文件获取具体信息。 目录结构以 skills/github-docs/ 为根,包含 SKILL.md、references/(按类别与主题分文件)、samples/、scripts/。
【适用场景】 适合需要查询 GitHub Actions 配置、GitHub API 用法、认证方式、Webhooks 与 GitHub Apps 开发、gh CLI 命令以及仓库和 PR 相关操作文档的开发与自动化任务。
【限制】 该技能为文档参考集合,具体条目内容取决于收录的官方文档版本;本介绍不包含任何安装命令、价格与平台支持等未在资料中提供的信息,相关内容暂未提供。