github.mdx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. ---
  2. title: GitHub
  3. description: Verwenden Sie OpenCode in GitHub-Problemen und Pull-Requests.
  4. ---
  5. OpenCode lässt sich in Ihren GitHub-Workflow integrieren. Erwähnen Sie `/opencode` oder `/oc` in Ihrem Kommentar, und OpenCode führt Aufgaben in Ihrem GitHub Actions-Runner aus.
  6. ---
  7. ## Features
  8. - **Issue Triage**: Bitten Sie OpenCode, ein Problem zu untersuchen und es Ihnen zu erklären.
  9. - **Reparieren und implementieren**: Bitten Sie OpenCode, ein Problem zu beheben oder eine Funktion zu implementieren. Und es funktioniert in einem neuen Branch und sendet ein PR mit allen Änderungen.
  10. - **Sicher**: OpenCode läuft in den Runners Ihres GitHub.
  11. ---
  12. ## Installation
  13. Führen Sie den folgenden Befehl in einem Projekt aus, das sich in einem GitHub-Repository befindet:
  14. ```bash
  15. opencode github install
  16. ```
  17. Dies führt Sie durch die Installation der GitHub-App, das Erstellen des Workflows und das Einrichten von Secrets.
  18. ---
  19. ### Manuelle Einrichtung
  20. Oder Sie können es manuell einrichten.
  21. 1. **Installieren Sie die GitHub-App**
  22. Gehen Sie zu [**github.com/apps/opencode-agent**](https://github.com/apps/opencode-agent). Stellen Sie sicher, dass es im Ziel-Repository installiert ist.
  23. 2. **Den Workflow hinzufügen**
  24. Fügen Sie die folgende Workflowdatei zu `.github/workflows/opencode.yml` in Ihrem Repository hinzu. Stellen Sie sicher, dass Sie in `env` die passenden Werte für `model` und `api_key` setzen.
  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. **Speichern Sie die API-Schlüssel in Secrets**
  56. Erweitern Sie in den **Einstellungen** Ihrer Organisation oder Ihres Projekts links **Secrets und Variablen** und wählen Sie **Aktionen** aus. Und fügen Sie die erforderlichen API-Schlüssel hinzu.
  57. ---
  58. ## Configuration
  59. - `model`: Das mit OpenCode zu verwendende Modell. Nimmt das Format `provider/model` an. Dies ist **erforderlich**.
  60. - `agent`: Der zu verwendende Agent. Muss ein Hauptagent sein. Fällt aus der Konfiguration auf `default_agent` oder `"build"` zurück, wenn es nicht gefunden wird.
  61. - `share`: Ob die OpenCode-Sitzung geteilt werden soll. Der Standardwert ist **true** für öffentliche Repositorys.
  62. - `prompt`: Optionale benutzerdefinierte Eingabeaufforderung zum Überschreiben des Standardverhaltens. Verwenden Sie dies, um anzupassen, wie OpenCode Anfragen verarbeitet.
  63. - `token`: Optionales GitHub-Zugriffstoken zum Ausführen von Vorgängen wie dem Erstellen von Kommentaren, dem Festschreiben von Änderungen und dem Öffnen von Pull Requests. Standardmäßig verwendet OpenCode das Installation Access Token der OpenCode GitHub-App, sodass Commits, Kommentare und Pull Requests so aussehen, als würden sie von der App kommen.
  64. Alternativ können Sie [built-in `GITHUB_TOKEN`](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) des GitHub Action Runners verwenden, ohne die OpenCode GitHub App zu installieren. Stellen Sie einfach sicher, dass Sie in Ihrem Workflow die erforderlichen Berechtigungen erteilen:
  65. ```yaml
  66. permissions:
  67. id-token: write
  68. contents: write
  69. pull-requests: write
  70. issues: write
  71. ```
  72. Sie können bei Bedarf auch einen [personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)(PAT) verwenden.
  73. ---
  74. ## Unterstützte Events
  75. OpenCode kann durch die folgenden GitHub-Events ausgelöst werden:
  76. | Ereignistyp | Ausgelöst durch | Einzelheiten |
  77. | ----------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
  78. | `issue_comment` | Kommentieren Sie ein Problem oder PR | Erwähnen Sie `/opencode` oder `/oc` in Ihrem Kommentar. OpenCode liest den Kontext und kann Branches erstellen, PRs öffnen oder antworten. |
  79. | `pull_request_review_comment` | Kommentieren Sie bestimmte Codezeilen in einem PR | Erwähnen Sie `/opencode` oder `/oc` beim Überprüfen des Codes. OpenCode empfängt Dateipfad, Zeilennummern und Diff Context. |
  80. | `issues` | Problem geöffnet oder bearbeitet | Lösen Sie OpenCode automatisch aus, wenn Probleme erstellt oder geändert werden. Erfordert `prompt`-Eingabe. |
  81. | `pull_request` | PR geöffnet oder aktualisiert | Lösen Sie OpenCode automatisch aus, wenn PRs geöffnet, synchronisiert oder erneut geöffnet werden. Nützlich für automatisierte Bewertungen. |
  82. | `schedule` | Cron-basierter Zeitplan | Führen Sie OpenCode nach einem Zeitplan aus. Erfordert `prompt`-Eingabe. Die Ausgabe geht an Protokolle und PRs (kein Kommentar zu diesem Problem). |
  83. | `workflow_dispatch` | Manueller Trigger von GitHub UI | Lösen Sie OpenCode bei Bedarf über die Actions Tab aus. Erfordert `prompt`-Eingabe. Die Ausgabe erfolgt an Protokolle und PRs. |
  84. ### Beispiel für einen Zeitplan
  85. Führen Sie OpenCode nach einem Zeitplan aus, um automatisierte Aufgaben auszuführen:
  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. Für geplante Ereignisse ist die Eingabe `prompt` **erforderlich**, da es keinen Kommentar gibt, aus dem Anweisungen extrahiert werden können. Geplante Workflows werden ohne Benutzerkontext zur Berechtigungsprüfung ausgeführt. Daher muss der Workflow `contents: write` und `pull-requests: write` gewähren, wenn Sie erwarten, dass OpenCode Branches oder PRs erstellt.
  115. ---
  116. ### Pull-Request-Beispiel
  117. Überprüfen Sie PRs automatisch, wenn sie geöffnet oder aktualisiert werden:
  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. Wenn für `pull_request`-Ereignisse kein `prompt` bereitgestellt wird, überprüft OpenCode standardmäßig die Pull-Anfrage.
  149. ---
  150. ### Beispiel für eine Issue Triage
  151. Neue Probleme automatisch selektieren. In diesem Beispiel wird nach Konten gefiltert, die älter als 30 Tage sind, um Spam zu reduzieren:
  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. Für `issues`-Ereignisse ist die Eingabe `prompt` **erforderlich**, da es keinen Kommentar gibt, aus dem Anweisungen extrahiert werden können.
  195. ---
  196. ## Benutzerdefinierte Eingabeaufforderungen
  197. Überschreiben Sie die Standardaufforderung, um das Verhalten von OpenCode für Ihren Workflow anzupassen.
  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. Dies ist nützlich, um bestimmte Prüfkriterien, Kodierungsstandards oder Schwerpunktbereiche durchzusetzen, die für Ihr Projekt relevant sind.
  209. ---
  210. ## Examples
  211. Hier sind einige Beispiele, wie Sie OpenCode in GitHub verwenden können.
  212. - **Erklären Sie ein Problem**
  213. Fügen Sie diesen Kommentar in einer GitHub-Ausgabe hinzu.
  214. ```
  215. /opencode explain this issue
  216. ```
  217. OpenCode liest den gesamten Thread, einschließlich aller Kommentare, und antwortet mit einer klaren Erklärung.
  218. - **Ein Problem beheben**
  219. Sagen Sie in einer GitHub-Ausgabe:
  220. ```
  221. /opencode fix this
  222. ```
  223. Und OpenCode erstellt einen neuen Branch, implementiert die Änderungen und öffnet ein PR mit den Änderungen.
  224. - **PRs überprüfen und Änderungen vornehmen**
  225. Hinterlassen Sie den folgenden Kommentar auf einem GitHub PR.
  226. ```
  227. Delete the attachment from S3 when the note is removed /oc
  228. ```
  229. OpenCode implementiert die angeforderte Änderung und schreibt sie an denselben PR fest.
  230. - **Überprüfen Sie bestimmte Codezeilen**
  231. Hinterlassen Sie einen Kommentar direkt zu den Codezeilen auf der Files Tab von PR. OpenCode erkennt automatisch die Datei, Zeilennummern und den Diff Context, um präzise Antworten bereitzustellen.
  232. ```
  233. [Comment on specific lines in Files tab]
  234. /oc add error handling here
  235. ```
  236. Beim Kommentieren bestimmter Zeilen erhält OpenCode:
  237. - Die genaue Datei, die überprüft wird
  238. - Die spezifischen Codezeilen
  239. - Der umgebende Diff Context
  240. - Informationen zur Zeilennummer
  241. Dies ermöglicht gezieltere Anfragen, ohne dass Dateipfade oder Zeilennummern manuell angegeben werden müssen.