日本語
ドキュメント
GitHub

GitHub

GitHub の issues と pull requests で OpenCode を使用します。

OpenCode は GitHub ワークフローと統合されています。コメントで /opencode または /oc をメンションすると、OpenCode が GitHub Actions runner 内でタスクを実行します。


機能

  • Issue のトリアージ:OpenCode に issue を調査して説明してもらいます。
  • 修正と実装:OpenCode に issue の修正や機能の実装を依頼します。新しいブランチで作業し、すべての変更を含む PR を提出します。
  • セキュア:OpenCode は GitHub の runner 内で実行されます。

インストール

GitHub リポジトリ内のプロジェクトで以下のコマンドを実行します:

opencode github install

これにより、GitHub app のインストール、ワークフローの作成、secrets の設定が案内されます。


手動セットアップ

手動でセットアップすることもできます。

  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. secrets に API キーを保存

    組織またはプロジェクトの設定で、左側の Secrets and variables を展開し、Actions を選択します。そして必要な API キーを追加します。


設定

  • model:OpenCode で使用するモデル。provider/model の形式を取ります。これは必須です。

  • agent:使用するエージェント。プライマリエージェントである必要があります。見つからない場合は、設定の default_agent または "build" にフォールバックします。

  • share:OpenCode セッションを共有するかどうか。パブリックリポジトリではデフォルトで true です。

  • prompt:デフォルトの動作をオーバーライドするオプションのカスタムプロンプト。OpenCode がリクエストを処理する方法をカスタマイズするために使用します。

  • token:コメントの作成、変更のコミット、pull requests のオープンなどの操作を実行するためのオプションの GitHub アクセストークン。デフォルトでは、OpenCode は OpenCode GitHub App からのインストールアクセストークンを使用するため、コミット、コメント、pull requests はアプリからのものとして表示されます。

    または、OpenCode GitHub App をインストールせずに、GitHub Action runner の組み込み GITHUB_TOKEN (opens in a new tab) を使用できます。ワークフローで必要な権限を付与してください:

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

    お好みで個人アクセストークン (opens in a new tab)(PAT)を使用することもできます。


サポートされるイベント

OpenCode は以下の GitHub イベントでトリガーできます:

イベントタイプトリガー方法詳細
issue_commentissue または PR へのコメントコメントで /opencode または /oc をメンション。OpenCode はコンテキストを読み取り、ブランチの作成、PR のオープン、返信ができます。
pull_request_review_commentPR の特定のコード行へのコメントコードレビュー中に /opencode または /oc をメンション。OpenCode はファイルパス、行番号、diff コンテキストを受け取ります。
issuesIssue がオープンまたは編集されたissues が作成または変更されたときに自動的に OpenCode をトリガー。prompt 入力が必要です。
pull_requestPR がオープンまたは更新されたPR がオープン、同期、または再オープンされたときに自動的に OpenCode をトリガー。自動レビューに便利です。
scheduleCron ベースのスケジュールスケジュールで OpenCode を実行。prompt 入力が必要です。出力はログと PR に送られます(コメントする issue がありません)。
workflow_dispatchGitHub 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: writepull-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 をレビューします。


Issues トリアージ例

新しい issues を自動的にトリアージ。この例では、スパムを減らすために 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 コンテキスト
    • 行番号情報

    これにより、ファイルパスや行番号を手動で指定することなく、より的を絞ったリクエストが可能になります。