github-ops

GitHub 操作

概述

此技能提供使用 gh CLI 工具和 GitHub REST/GraphQL API 执行 GitHub 操作的全面指南。执行任何与 GitHub 相关的任务时均可使用此技能，包括拉取请求管理、问题跟踪、仓库操作、工作流自动化和 API 交互。

何时使用此技能

涉及以下任务时，此技能会启用：

• 创建、查看、编辑或合并拉取请求
• 管理 GitHub 问题或仓库设置
• 查询 GitHub API 端点（REST 或 GraphQL）
• 使用 GitHub Actions 工作流
• 对仓库执行批量操作
• 集成 GitHub Enterprise
• 通过 CLI 或 API 自动执行 GitHub 操作

核心操作

拉取请求

# Create PR (タイトルはプロジェクトの commit/PR 規約に従う)
gh pr create --title "feat: your PR title" --body "PR description"

# List and view PRs
gh pr list --state open
gh pr view 123

# Manage PRs
gh pr merge 123 --squash
gh pr review 123 --approve
gh pr comment 123 --body "LGTM"

📚 如需全面了解 PR 工作流，请参阅 references/pr_operations.md

PR 标题约定：

• 遵循项目的规范（Conventional Commits、工单 ID 前缀等）
• 如果工单跟踪器集成要求使用必需前缀，请参阅目标项目的规范文档

问题

# Create and manage issues
gh issue create --title "Bug: Issue title" --body "Issue description"
gh issue list --state open --label bug
gh issue edit 456 --add-label "priority-high"
gh issue close 456

📚 如需详细了解问题管理，请参阅 references/issue_operations.md

仓库

# View and manage repos
gh repo view --web
gh repo clone owner/repo
gh repo create my-new-repo --public

工作流

# Manage GitHub Actions
gh workflow list
gh workflow run workflow-name
gh run watch run-id
gh run download run-id

📚 如需了解高级工作流操作，请参阅 references/workflow_operations.md

GitHub API

gh api 命令可直接访问 GitHub REST API 端点。有关 API 端点文档的完整内容，请参阅 references/api_reference.md。

基本 API 操作：

# Get PR details via API
gh api repos/{owner}/{repo}/pulls/{pr_number}

# Add PR comment
gh api repos/{owner}/{repo}/issues/{pr_number}/comments \
  -f body="Comment text"

# List workflow runs
gh api repos/{owner}/{repo}/actions/runs

对于需要多个相关资源的复杂查询，请使用 GraphQL。GraphQL 示例请参阅 references/api_reference.md。

身份验证和配置

# Login to GitHub
gh auth login

# Login to GitHub Enterprise
gh auth login --hostname github.enterprise.com

# Check authentication status
gh auth status

# Set default repository
gh repo set-default owner/repo

# Configure gh settings
gh config set editor vim
gh config set git_protocol ssh
gh config list

输出格式

控制用于程序化处理的输出格式：

# JSON output
gh pr list --json number,title,state,author

# JSON with jq processing
gh pr list --json number,title | jq '.[] | select(.title | contains("bug"))'

# Template output
gh pr list --template '{{range .}}{{.number}}: {{.title}}{{"\n"}}{{end}}'

📚 有关 Shell 模式和自动化策略，请参阅 references/best_practices.md

快速参考

最常见的操作：

gh pr create --title "feat: title" --body "Description"      # Create PR
gh pr list                                                  # List PRs
gh pr view 123                                              # View PR details
gh pr checks 123                                            # Check PR status
gh pr merge 123 --squash                                    # Merge PR
gh pr comment 123 --body "LGTM"                            # Comment on PR
gh issue create --title "Title" --body "Description"       # Create issue
gh workflow run workflow-name                               # Run workflow
gh repo view --web                                          # Open repo in browser
gh api repos/{owner}/{repo}/pulls/{pr_number}              # Direct API call

资源

references/pr_operations.md

全面介绍拉取请求操作，包括：

• 详细的 PR 创建模式（工单跟踪器集成、从文件读取正文、指定目标分支）
• 查看和筛选策略
• 审查工作流和批准模式
• PR 生命周期管理
• 批量操作和自动化示例

处理复杂的 PR 工作流或批量操作时，请加载此参考文档。

references/issue_operations.md

详细的问题管理示例，包括：

• 创建带标签和受理人的问题
• 高级筛选和搜索
• 问题生命周期和状态管理
• 对多个问题执行批量操作
• 与 PR 和项目集成

大规模管理问题或设置问题工作流时，请加载此参考文档。

references/workflow_operations.md

高级 GitHub Actions 工作流操作，包括：

• 工作流触发器和手动运行
• 运行监控和调试
• 构件管理
• 密钥和变量
• 性能优化策略

处理 CI/CD 工作流或调试失败的运行时，请加载此参考文档。

references/best_practices.md

Shell 脚本模式和自动化策略，包括：

• 输出格式（JSON、模板、jq）
• 分页和大型结果集
• 错误处理和重试逻辑
• 批量操作和并行执行
• GitHub Enterprise 模式
• 性能优化

构建自动化脚本或处理企业部署时，请加载此参考文档。

references/api_reference.md

包含全面的 GitHub REST API 端点文档，包括：

• 完整的 API 端点参考和示例
• 请求/响应格式
• 身份验证模式
• 速率限制指南
• Webhook 配置
• 高级 GraphQL 查询模式

执行复杂的 API 操作或需要详细的端点规范时，请加载此参考文档。