github.mdx 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. ---
  2. title: GitHub
  3. description: GitHub の問題とプルリクエストで OpenCode を使用します。
  4. ---
  5. OpenCode は GitHub ワークフローと統合します。コメントで `/opencode` または `/oc` に言及すると、OpenCode が GitHub Actions ランナー内でタスクを実行します。
  6. ---
  7. ## 特徴
  8. - **問題のトリアージ**: OpenCode に問題を調べて説明してもらいます。
  9. - **修正と実装**: OpenCode に問題の修正または機能の実装を依頼します。そして、新しいブランチで動作し、すべての変更を含む PR を送信します。
  10. - **安全**: OpenCode は GitHub のランナー内で実行されます。
  11. ---
  12. ## インストール
  13. GitHub リポジトリにあるプロジェクトで次のコマンドを実行します。
  14. ```bash
  15. opencode github install
  16. ```
  17. ここでは、GitHub アプリのインストール、ワークフローの作成、シークレットの設定について説明します。
  18. ---
  19. ### 手動セットアップ
  20. または、手動で設定することもできます。
  21. 1. **GitHub アプリをインストールします**
  22. [**github.com/apps/opencode-agent**](https://github.com/apps/opencode-agent) にアクセスしてください。ターゲット リポジトリにインストールされていることを確認してください。
  23. 2. **ワークフローを追加**
  24. 次のワークフロー ファイルをリポジトリの `.github/workflows/opencode.yml` に追加します。適切な `model` と必要な API キーを `env` に設定してください。
  25. ```yml title=".github/workflows/opencode.yml" {24,26}
  26. name: opencode
  27. on:
  28. issue_comment:
  29. types: [created]
  30. pull_request_review_comment:
  31. types: [created]
  32. jobs:
  33. opencode:
  34. if: |
  35. contains(github.event.comment.body, '/oc') ||
  36. contains(github.event.comment.body, '/opencode')
  37. runs-on: ubuntu-latest
  38. permissions:
  39. id-token: write
  40. steps:
  41. - name: Checkout repository
  42. uses: actions/checkout@v6
  43. with:
  44. fetch-depth: 1
  45. persist-credentials: false
  46. - name: Run OpenCode
  47. uses: anomalyco/opencode/github@latest
  48. env:
  49. ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  50. with:
  51. model: anthropic/claude-sonnet-4-20250514
  52. # share: true
  53. # github_token: xxxx
  54. ```
  55. 3. **API キーをシークレットに保存します**
  56. 組織またはプロジェクトの**設定**で、左側の**シークレットと変数**を展開し、**アクション**を選択します。そして、必要な API キーを追加します。
  57. ---
  58. ## 構成
  59. - `model`: OpenCode で使用するモデル。 `provider/model` の形式をとります。これは**必須**です。
  60. - `agent`: 使用するエージェント。プライマリ エージェントである必要があります。見つからない場合は、設定から `default_agent` にフォールバックするか、`"build"` にフォールバックします。
  61. - `share`: OpenCode セッションを共有するかどうか。パブリック リポジトリのデフォルトは **true** です。
  62. - `prompt`: デフォルトの動作をオーバーライドするためのオプションのカスタム プロンプト。これを使用して、OpenCode がリクエストを処理する方法をカスタマイズします。
  63. - `token`: コメントの作成、変更のコミット、プル リクエストのオープンなどの操作を実行するためのオプションの GitHub アクセス トークン。デフォルトでは、OpenCode は OpenCode GitHub アプリからのインストール アクセス トークンを使用するため、コミット、コメント、プル リクエストはアプリからのものとして表示されます。
  64. あるいは、OpenCode GitHub アプリをインストールせずに、GitHub Action ランナーの [組み込み `GITHUB_TOKEN`](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) を使用することもできます。ワークフローで必要な権限を必ず付与してください。
  65. ```yaml
  66. permissions:
  67. id-token: write
  68. contents: write
  69. pull-requests: write
  70. issues: write
  71. ```
  72. 必要に応じて、[パーソナル アクセス トークン](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)(PAT) を使用することもできます。
  73. ---
  74. ## サポートされているイベント
  75. OpenCode は、次の GitHub イベントによってトリガーできます。
  76. | イベントの種類 | きっかけ | 詳細 |
  77. | ----------------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
  78. | `issue_comment` | 問題または PR についてコメントする | コメントで `/opencode` または `/oc` について言及してください。 OpenCode はコンテキストを読み取り、ブランチを作成したり、PR を開いたり、返信したりできます。 |
  79. | `pull_request_review_comment` | PR 内の特定のコード行にコメントする | コードをレビューするときに、`/opencode` または `/oc` について言及します。 OpenCode は、ファイル パス、行番号、および diff コンテキストを受け取ります。 |
  80. | `issues` | 問題がオープンまたは編集されました | 問題が作成または変更されると、OpenCode が自動的にトリガーされます。 `prompt` 入力が必要です。 |
  81. | `pull_request` | PR がオープンまたは更新されました | PR が開かれる、同期される、または再度開かれるときに、OpenCode を自動的にトリガーします。自動レビューに役立ちます。 |
  82. | `schedule` | Cron ベースのスケジュール | スケジュールに従って OpenCode を実行します。 `prompt` 入力が必要です。出力はログと PR に送られます (コメントする問題はありません)。 |
  83. | `workflow_dispatch` | GitHub UI からの手動トリガー | [アクション] タブから OpenCode をオンデマンドでトリガーします。 `prompt` 入力が必要です。出力はログと PR に送られます。 |
  84. ### スケジュール例
  85. スケジュールに従って OpenCode を実行し、自動化されたタスクを実行します。
  86. ```yaml title=".github/workflows/opencode-scheduled.yml"
  87. name: Scheduled OpenCode Task
  88. on:
  89. schedule:
  90. - cron: "0 9 * * 1" # Every Monday at 9am UTC
  91. jobs:
  92. opencode:
  93. runs-on: ubuntu-latest
  94. permissions:
  95. id-token: write
  96. contents: write
  97. pull-requests: write
  98. issues: write
  99. steps:
  100. - name: Checkout repository
  101. uses: actions/checkout@v6
  102. with:
  103. persist-credentials: false
  104. - name: Run OpenCode
  105. uses: anomalyco/opencode/github@latest
  106. env:
  107. ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  108. with:
  109. model: anthropic/claude-sonnet-4-20250514
  110. prompt: |
  111. Review the codebase for any TODO comments and create a summary.
  112. If you find issues worth addressing, open an issue to track them.
  113. ```
  114. スケジュールされたイベントの場合、指示を抽出するためのコメントがないため、`prompt` 入力は **必須** です。スケジュールされたワークフローは、権限チェックのためのユーザー コンテキストなしで実行されるため、OpenCode がブランチまたは PR を作成することが予想される場合、ワークフローは `contents: write` および `pull-requests: write` を付与する必要があります。
  115. ---
  116. ### プルリクエストの例
  117. PR が開かれるか更新されるときに、PR を自動的にレビューします。
  118. ```yaml title=".github/workflows/opencode-review.yml"
  119. name: opencode-review
  120. on:
  121. pull_request:
  122. types: [opened, synchronize, reopened, ready_for_review]
  123. jobs:
  124. review:
  125. runs-on: ubuntu-latest
  126. permissions:
  127. id-token: write
  128. contents: read
  129. pull-requests: read
  130. issues: read
  131. steps:
  132. - uses: actions/checkout@v6
  133. with:
  134. persist-credentials: false
  135. - uses: anomalyco/opencode/github@latest
  136. env:
  137. ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  138. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  139. with:
  140. model: anthropic/claude-sonnet-4-20250514
  141. use_github_token: true
  142. prompt: |
  143. Review this pull request:
  144. - Check for code quality issues
  145. - Look for potential bugs
  146. - Suggest improvements
  147. ```
  148. `pull_request` イベントの場合、`prompt` が指定されていない場合、OpenCode はデフォルトでプル リクエストをレビューします。
  149. ---
  150. ### 問題のトリアージの例
  151. 新しい問題を自動的に優先順位付けします。この例では、スパムを減らすために 30 日より古いアカウントにフィルターを適用します。
  152. ```yaml title=".github/workflows/opencode-triage.yml"
  153. name: Issue Triage
  154. on:
  155. issues:
  156. types: [opened]
  157. jobs:
  158. triage:
  159. runs-on: ubuntu-latest
  160. permissions:
  161. id-token: write
  162. contents: write
  163. pull-requests: write
  164. issues: write
  165. steps:
  166. - name: Check account age
  167. id: check
  168. uses: actions/github-script@v7
  169. with:
  170. script: |
  171. const user = await github.rest.users.getByUsername({
  172. username: context.payload.issue.user.login
  173. });
  174. const created = new Date(user.data.created_at);
  175. const days = (Date.now() - created) / (1000 * 60 * 60 * 24);
  176. return days >= 30;
  177. result-encoding: string
  178. - uses: actions/checkout@v6
  179. if: steps.check.outputs.result == 'true'
  180. with:
  181. persist-credentials: false
  182. - uses: anomalyco/opencode/github@latest
  183. if: steps.check.outputs.result == 'true'
  184. env:
  185. ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  186. with:
  187. model: anthropic/claude-sonnet-4-20250514
  188. prompt: |
  189. Review this issue. If there's a clear fix or relevant docs:
  190. - Provide documentation links
  191. - Add error handling guidance for code examples
  192. Otherwise, do not comment.
  193. ```
  194. `issues` イベントの場合、指示を抽出するためのコメントがないため、`prompt` 入力は **必須** です。
  195. ---
  196. ## カスタムプロンプト
  197. デフォルトのプロンプトをオーバーライドして、ワークフローに合わせて OpenCode の動作をカスタマイズします。
  198. ```yaml title=".github/workflows/opencode.yml"
  199. - uses: anomalyco/opencode/github@latest
  200. with:
  201. model: anthropic/claude-sonnet-4-5
  202. prompt: |
  203. Review this pull request:
  204. - Check for code quality issues
  205. - Look for potential bugs
  206. - Suggest improvements
  207. ```
  208. これは、プロジェクトに関連する特定のレビュー基準、コーディング標準、または重点分野を強制するのに役立ちます。
  209. ---
  210. ## 例
  211. GitHub で OpenCode を使用する方法の例をいくつか示します。
  212. - **問題の説明**
  213. このコメントを GitHub の問題に追加します。
  214. ```
  215. /opencode explain this issue
  216. ```
  217. OpenCode は、すべてのコメントを含むスレッド全体を読み取り、明確な説明を返信します。
  218. - **問題を修正**
  219. GitHub の問題で次のように言います。
  220. ```
  221. /opencode fix this
  222. ```
  223. そして、OpenCode は新しいブランチを作成し、変更を実装し、変更を含む PR を開きます。
  224. - **PR を確認して変更を加える**
  225. GitHub PR に次のコメントを残してください。
  226. ```
  227. Delete the attachment from S3 when the note is removed /oc
  228. ```
  229. OpenCode は要求された変更を実装し、同じ PR にコミットします。
  230. - **特定のコード行を確認してください**
  231. PR の「ファイル」タブのコード行に直接コメントを残します。 OpenCode は、ファイル、行番号、および diff コンテキストを自動的に検出して、正確な応答を提供します。
  232. ```
  233. [Comment on specific lines in Files tab]
  234. /oc add error handling here
  235. ```
  236. 特定の行にコメントすると、OpenCode は以下を受け取ります。
  237. - レビューされている正確なファイル
  238. - コードの特定の行
  239. - 周囲の差分コンテキスト
  240. - 行番号情報
  241. これにより、ファイル パスや行番号を手動で指定する必要がなく、よりターゲットを絞ったリクエストが可能になります。