中文
文档
GitHub 集成

GitHub

在 GitHub issue 和 pull request 中使用 OpenCode。

OpenCode 与你的 GitHub 工作流集成。在你的评论中提及 /opencode 或 /oc，OpenCode 就会在你的 GitHub Actions runner 中执行任务。

功能

  • 分类 issue：让 OpenCode 调查一个 issue 并向你解释它。
  • 修复与实现：让 OpenCode 修复一个 issue 或实现一个功能。它会在一个新分支中工作，并提交一个包含所有变更的 PR。
  • 安全：OpenCode 在你 GitHub 的 runner 内运行。

安装

在一个位于 GitHub 仓库中的项目里运行以下命令：

opencode github install

这会引导你完成安装 GitHub app、创建工作流和设置 secret 的过程。

手动设置

或者你可以手动设置。

  1. 安装 GitHub app 前往 github.com/apps/opencode-agent (opens in a new tab)。确保它已安装到目标仓库。

  2. 添加工作流 将以下工作流文件添加到你仓库的 .github/workflows/opencode.yml。务必在 env 中设置合适的 model 和所需的 API 密钥。

    .github/workflows/opencode.yml
    name: opencode
 
on:
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]
 
jobs:
  opencode:
    if: |
      contains(github.event.comment.body, '/oc') ||
      contains(github.event.comment.body, '/opencode')
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    steps:
       - name: Checkout repository
         uses: actions/checkout@v6
         with:
           fetch-depth: 1
           persist-credentials: false
 
       - name: Run OpenCode
        uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          # share: true
          # github_token: xxxx

  3. 将 API 密钥存储在 secret 中 在你的组织或项目设置中，展开左侧的 Secrets and variables 并选择 Actions，然后添加所需的 API 密钥。

配置

  • model：与 OpenCode 一起使用的模型。采用 provider/model 格式。这是必需的。

  • agent：要使用的 agent。必须是一个主 agent。若未找到，则回退到配置中的 default_agent 或 "build"。

  • share：是否分享 OpenCode 会话。对于公开仓库默认为 true。

  • prompt：可选的自定义提示词，用于覆盖默认行为。用它来自定义 OpenCode 处理请求的方式。

  • token：可选的 GitHub 访问令牌，用于执行创建评论、提交变更和开启 pull request 等操作。默认情况下，OpenCode 使用来自 OpenCode GitHub App 的安装访问令牌，因此提交、评论和 pull request 会显示为来自该 app。或者，你可以使用 GitHub Action runner 的内置 GITHUB_TOKEN (opens in a new tab)，无需安装 OpenCode GitHub App。只需确保在你的工作流中授予所需的权限：

    permissions:
  id-token: write
  contents: write
  pull-requests: write
  issues: write

    如果你更愿意，也可以使用个人访问令牌 (opens in a new tab)（PAT）。

受支持的事件

OpenCode 可以由以下 GitHub 事件触发：

事件类型触发方式详情
issue_comment在 issue 或 PR 上评论在你的评论中提及 /opencode 或 /oc。OpenCode 读取上下文，可以创建分支、开启 PR 或回复。
pull_request_review_comment在 PR 中特定代码行上评论在审查代码时提及 /opencode 或 /oc。OpenCode 会收到文件路径、行号和 diff 上下文。
issuesissue 被开启或编辑当 issue 被创建或修改时自动触发 OpenCode。需要 prompt 输入。
pull_requestPR 被开启或更新当 PR 被开启、同步或重新开启时自动触发 OpenCode。适用于自动化审查。
schedule基于 Cron 的计划按计划运行 OpenCode。需要 prompt 输入。输出进入日志和 PR（没有可供评论的 issue）。
workflow_dispatch从 GitHub UI 手动触发通过 Actions 标签页按需触发 OpenCode。需要 prompt 输入。输出进入日志和 PR。

计划任务示例

按计划运行 OpenCode 以执行自动化任务：

.github/workflows/opencode-scheduled.yml
name: Scheduled OpenCode Task
 
on:
  schedule:
    - cron: "0 9 * * 1" # Every Monday at 9am UTC
 
jobs:
  opencode:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          persist-credentials: false
 
      - name: Run OpenCode
        uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review the codebase for any TODO comments and create a summary.
            If you find issues worth addressing, open an issue to track them.

对于计划任务事件，prompt 输入是必需的，因为没有评论可供提取指令。计划工作流在没有用户上下文供权限检查的情况下运行，因此如果你希望 OpenCode 创建分支或 PR，工作流必须授予 contents: write 和 pull-requests: write。

Pull Request 示例

在 PR 被开启或更新时自动审查它们：

.github/workflows/opencode-review.yml
name: opencode-review
 
on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
 
jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
      pull-requests: read
      issues: read
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
      - uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          use_github_token: true
          prompt: |
            Review this pull request:
            - Check for code quality issues
            - Look for potential bugs
            - Suggest improvements

对于 pull_request 事件，如果未提供 prompt，OpenCode 默认会审查该 pull request。

Issue 分类示例

自动分类新 issue。此示例筛选出账户存在超过 30 天的用户以减少垃圾信息：

.github/workflows/opencode-triage.yml
name: Issue Triage
 
on:
  issues:
    types: [opened]
 
jobs:
  triage:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Check account age
        id: check
        uses: actions/github-script@v7
        with:
          script: |
            const user = await github.rest.users.getByUsername({
              username: context.payload.issue.user.login
            });
            const created = new Date(user.data.created_at);
            const days = (Date.now() - created) / (1000 * 60 * 60 * 24);
            return days >= 30;
          result-encoding: string
 
      - uses: actions/checkout@v6
        if: steps.check.outputs.result == 'true'
        with:
          persist-credentials: false
 
      - uses: anomalyco/opencode/github@latest
        if: steps.check.outputs.result == 'true'
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review this issue. If there's a clear fix or relevant docs:
            - Provide documentation links
            - Add error handling guidance for code examples
            Otherwise, do not comment.

对于 issues 事件，prompt 输入是必需的，因为没有评论可供提取指令。

自定义提示词

覆盖默认提示词，为你的工作流自定义 OpenCode 的行为。

.github/workflows/opencode.yml
- uses: anomalyco/opencode/github@latest
  with:
    model: anthropic/claude-sonnet-4-5
    prompt: |
      Review this pull request:
      - Check for code quality issues
      - Look for potential bugs
      - Suggest improvements

这对于强制执行特定的审查标准、编码规范或与你项目相关的关注重点很有用。

示例

下面是一些如何在 GitHub 中使用 OpenCode 的示例。

  • 解释一个 issue 在 GitHub issue 中添加此评论。

    /opencode explain this issue

    OpenCode 会读取整个讨论串，包括所有评论，并回复一个清晰的解释。

  • 修复一个 issue 在 GitHub issue 中说：

    /opencode fix this

    然后 OpenCode 会创建一个新分支，实现变更，并开启一个包含变更的 PR。

  • 审查 PR 并进行修改 在 GitHub PR 上留下以下评论。

    Delete the attachment from S3 when the note is removed /oc

    OpenCode 会实现所请求的变更，并将其提交到同一个 PR。

  • 审查特定代码行 直接在 PR "Files" 标签页的代码行上留下评论。OpenCode 会自动检测文件、行号和 diff 上下文，以提供精准的回应。

    [Comment on specific lines in Files tab]
/oc add error handling here

    在特定行上评论时，OpenCode 会收到：

    • 正在被审查的确切文件
    • 特定的代码行
    • 周围的 diff 上下文
    • 行号信息

    这使得能够发出更有针对性的请求，而无需手动指定文件路径或行号。

分享GitLab 集成