Skip to content

5.14 GitHub 集成

💡 一句话总结:配置 GitHub 集成,实现代码协作自动化。


学完你能做什么

  • 能连接 GitHub 仓库
  • 能使用 GitHub 工具
  • 能配置自动操作
  • 能处理 Pull Request

🎒 开始前的准备

确保你已经完成以下事项:

  • [ ] 有 GitHub 账号
  • [ ] 有 GitHub Personal Access Token

配置

基础配置

yaml
github:
  enabled: true
  
  auth:
    token: "${GITHUB_TOKEN}"
  
  default_org: "my-org"
  default_repo: "my-project"

仓库配置

yaml
github:
  repositories:
    - owner: "my-org"
      repo: "frontend"
      default_branch: "main"
    
    - owner: "my-org"
      repo: "backend"
      default_branch: "main"

工具

仓库操作

bash
# 列出仓库
/github list-repos --org my-org

# 获取仓库信息
/github get-repo --owner my-org --repo my-project

# 创建仓库
/github create-repo --name new-project --private

文件操作

bash
# 读取文件
/github read-file --owner my-org --repo my-project --path src/app.ts

# 创建/更新文件
/github create-or-update-file \
  --owner my-org \
  --repo my-project \
  --path "src/new.ts" \
  --content "文件内容" \
  --message "添加新文件"

Pull Request

bash
# 创建 PR
/github create-pr \
  --owner my-org \
  --repo my-project \
  --title "功能更新" \
  --body "描述..." \
  --head feature-branch \
  --base main

# 列出 PR
/github list-prs --owner my-org --repo my-project --state open

# 合并 PR
/github merge-pr --owner my-org --repo my-project --pr-number 123

Issues

bash
# 创建 Issue
/github create-issue \
  --owner my-org \
  --repo my-project \
  --title "Bug 报告" \
  --body "描述..."

# 列出 Issues
/github list-issues --owner my-org --repo my-project

自动化

自动代码审查

yaml
github:
  automations:
    - name: "自动审查"
      trigger: "pull_request_opened"
      actions:
        - name: "运行测试"
          run: "npm test"
        
        - name: "代码审查"
          run: "npm run lint"
        
        - name: "添加标签"
          add_labels: ["needs-review"]

自动合并

yaml
github:
  automations:
    - name: "自动合并"
      trigger: "pull_request_approved"
      conditions:
        - "tests_passed"
        - "no_conflicts"
        - "approved"
      actions:
        - name: "合并 PR"
          merge_method: "squash"

跟我做

实战:配置 GitHub 集成

  1. 创建 GitHub Token:
bash
# 在 GitHub 设置中创建
# Settings > Developer settings > Personal access tokens
  1. 配置 OpenCode:
yaml
github:
  enabled: true
  auth:
    token: "${GITHUB_TOKEN}"
  
  repositories:
    - owner: "my-team"
      repo: "my-project"
  1. 测试集成:
列出 my-team/my-project 的所有 Issues

检查点 ✅

全部通过才能继续

  • [ ] 能配置 GitHub
  • [ ] 能使用工具
  • [ ] 能配置自动化
  • [ ] 能处理 PR

本课小结

你学会了:

  1. GitHub 配置
  2. 仓库操作
  3. 文件操作
  4. PR 和 Issues
  5. 自动化配置

下一课预告

下一课我们将学习 GitLab 集成。


📚 更多完整模板Prompt 模板库