github.mdx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. ---
  2. title: GitHub
  3. description: Bruk opencode i GitHub-problemer og pull-forespørsler.
  4. ---
  5. OpenCode integreres med GitHub-arbeidsflyten din. Nevn `/opencode` eller `/oc` i kommentaren din, og OpenCode vil utføre oppgaver i din GitHub Actions-løper.
  6. ---
  7. ## Funksjoner
  8. - **Triage saker**: Be OpenCode se på en sak og forklare den for deg.
  9. - **Fiks og implementer**: Be OpenCode om å fikse en sak eller implementere en funksjon. Den vil jobbe i en ny gren og sende inn en PR med alle endringene.
  10. - **Sikkert**: OpenCode kjører i GitHub-runners.
  11. ---
  12. ## Installasjon
  13. Kjør følgende kommando i et prosjekt som er et GitHub-repo:
  14. ```bash
  15. opencode github install
  16. ```
  17. Dette vil lede deg gjennom å installere GitHub-appen, lage arbeidsflyten og sette opp secrets (hemmeligheter).
  18. ---
  19. ### Manuelt oppsett
  20. Eller du kan sette den opp manuelt.
  21. 1. **Installer GitHub-appen**
  22. Gå over til [**github.com/apps/opencode-agent**](https://github.com/apps/opencode-agent). Sørg for at den er installert på mållageret.
  23. 2. **Legg til arbeidsflyten**
  24. Legg til følgende arbeidsflytfil til `.github/workflows/opencode.yml` i repoen. Sørg for å sette riktig `model` og nødvendige API-nøkler i `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. **Lagre API-nøklene i hemmeligheter**
  56. Utvid **Hemmeligheter og variabler** til venstre i **innstillingene** for organisasjonen eller prosjektet og velg **Actions**. Og legg til de nødvendige API-nøklene.
  57. ---
  58. ## Konfigurasjon
  59. - `model`: Modellen som skal brukes med OpenCode. Tar formatet `provider/model`. Dette er **obligatorisk**.
  60. - `agent`: Agenten som skal brukes. Må være en primær agent. Faller tilbake til `default_agent` fra config eller `"build"` hvis ikke funnet.
  61. - `share`: Om OpenCode-økten skal deles. Standard er **true** for offentlige depoter.
  62. - `prompt`: Valgfri egendefinert melding for å overstyre standard oppførsel. Bruk dette til å tilpasse hvordan OpenCode behandler forespørsler.
  63. - `token`: Valgfritt GitHub-tilgangstoken for å utføre operasjoner som å lage kommentarer, foreta endringer og åpne pull-forespørsler. Som standard bruker OpenCode installasjonstilgangstokenet fra OpenCode GitHub-appen, så commits, kommentarer og pull-forespørsler ser ut til å komme fra appen.
  64. Alternativt kan du bruke GitHub Action-løperens [innebygde `GITHUB_TOKEN`](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) uten å installere OpenCode GitHub-appen. Bare sørg for å gi de nødvendige tillatelsene i arbeidsflyten din:
  65. ```yaml
  66. permissions:
  67. id-token: write
  68. contents: write
  69. pull-requests: write
  70. issues: write
  71. ```
  72. Du kan også bruke en [personlig tilgangstoken](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)(PAT) hvis foretrukket.
  73. ---
  74. ## Støttede hendelser
  75. OpenCode kan utløses av følgende GitHub-hendelser:
  76. | Hendelsestype | Utløst av | Detaljer |
  77. | ----------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
  78. | `issue_comment` | Kommentar på sak eller PR | Nevn `/opencode` eller `/oc` i kommentaren din. OpenCode leser kontekst og kan opprette grener, åpne PR-er eller svare. |
  79. | `pull_request_review_comment` | Kommenter spesifikke kodelinjer i en PR | Nevn `/opencode` eller `/oc` mens du ser gjennom koden. OpenCode mottar filbane, linjenummer og diff-kontekst. |
  80. | `issues` | Sak åpnet eller redigert | Utløs OpenCode automatisk når saker opprettes eller endres. Krever `prompt` inngang. |
  81. | `pull_request` | PR åpnet eller oppdatert | Utløs OpenCode automatisk når PR-er åpnes, synkroniseres eller gjenåpnes. Nyttig for automatiserte anmeldelser. |
  82. | `schedule` | Cron-basert tidsplan | Kjør OpenCode etter en tidsplan. Krever `prompt` inngang. Utdata går til logger og PR (ingen sak å kommentere). |
  83. | `workflow_dispatch` | Manuell utløser fra GitHub UI | Utløs OpenCode på forespørsel via fanen Handlinger. Krever `prompt` inngang. Utdata går til logger og PR-er. |
  84. ### Eksempel på tidsplan
  85. Kjør OpenCode på en tidsplan for å utføre automatiserte oppgaver:
  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. For planlagte arrangementer er `prompt`-inngangen **påkrevd** siden det ikke er noen kommentarer å trekke ut instruksjoner fra. Planlagte workflows kjører uten brukerkontekst for tillatelsessjekking, så arbeidsflyten må gi `contents: write` og `pull-requests: write` hvis du forventer at OpenCode oppretter grener eller PR-er.
  115. ---
  116. ### Eksempel på Pull Request
  117. Gjennomgå PR-er automatisk når de åpnes eller oppdateres:
  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. For `pull_request`-hendelser, hvis ingen `prompt` er oppgitt, går OpenCode som standard gjennom PR-en.
  149. ---
  150. ### Eksempel på triage av saker
  151. Automatisk triage av nye saker. Dette eksemplet filtrerer til kontoer eldre enn 30 dager for å redusere spam:
  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. For `issues`-hendelser er `prompt`-inngangen **påkrevd** siden det ikke er noen kommentarer å trekke ut instruksjoner fra.
  195. ---
  196. ## Egendefinerte prompter
  197. Overstyr standardprompten for å tilpasse oppførselen til OpenCode for arbeidsflyten din.
  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. Dette er nyttig for å håndheve spesifikke vurderingskriterier, kodestandarder eller fokusområder som er relevante for prosjektet ditt.
  209. ---
  210. ## Eksempler
  211. Her er noen eksempler på hvordan du kan bruke OpenCode i GitHub.
  212. :::tip
  213. Du kan konfigurere til å bruke en annen triggerfrase enn `@opencode`.
  214. :::
  215. - **Forklar en sak (issue)**
  216. Legg til denne kommentaren i en GitHub-sak.
  217. ```
  218. /opencode explain this issue
  219. ```
  220. OpenCode vil lese hele tråden, inkludert alle kommentarer, og svare med en tydelig forklaring.
  221. - **Fiks en sak**
  222. I en GitHub-sak, si:
  223. ```
  224. /opencode fix this
  225. ```
  226. Og OpenCode vil opprette en ny gren, implementere endringene og åpne en PR med endringene.
  227. - **Se gjennom PR-er og gjør endringer**
  228. Legg igjen følgende kommentar på en GitHub PR.
  229. ```
  230. Delete the attachment from S3 when the note is removed /oc
  231. ```
  232. OpenCode vil implementere den forespurte endringen og committe den til samme PR.
  233. - **Review av spesifikke kodelinjer**
  234. Legg igjen en kommentar direkte på kodelinjer i PRs "Filer"-fane. OpenCode oppdager automatisk filen, linjenumrene og diff-konteksten for å gi presise svar.
  235. ```
  236. [Comment on specific lines in Files tab]
  237. /oc add error handling here
  238. ```
  239. Når du kommenterer spesifikke linjer, mottar OpenCode:
  240. - Den nøyaktige filen blir gjennomgått
  241. - De spesifikke kodelinjene
  242. - Den omkringliggende diff-konteksten
  243. - Linjenummerinformasjon
  244. Dette gir mulighet for mer målrettede forespørsler uten å måtte spesifisere filstier eller linjenumre manuelt.