github.mdx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. ---
  2. title: GitHub
  3. description: Brug OpenCode i GitHub-problemer og Pull Requests.
  4. ---
  5. OpenCode integreres med din GitHub arbejdsgang. Nævn `/opencode` eller `/oc` i din kommentar, og OpenCode vil udføre opgaver i din GitHub Actions-løber.
  6. ---
  7. ## Funktioner
  8. - **Triageproblemer**: Bed OpenCode om at undersøge et problem og forklare dig det.
  9. - **Ret og implementer**: Bed OpenCode om at løse et problem eller implementere en funktion. Og det vil fungere i en ny branch og indsende en PR med alle ændringerne.
  10. - **Sikker**: OpenCode løber inde i din GitHubs løbere.
  11. ---
  12. ## Installation
  13. Kør følgende kommando i et projekt, der er i en GitHub repo:
  14. ```bash
  15. opencode github install
  16. ```
  17. Dette vil lede dig gennem installation af GitHub-appen, oprettelse af arbejdsgangen og opsætning af hemmeligheder.
  18. ---
  19. ### Manuel opsætning
  20. Eller du kan indstille det manuelt.
  21. 1. **Installationsprogrammet GitHub-appen**
  22. Gå over til [**github.com/apps/opencode-agent**](https://github.com/apps/opencode-agent). Sørg for, at det er installeret på mållageret.
  23. 2. **Tilføj arbejdsgangen**
  24. Tilføj følgende workflow-fil til `.github/workflows/opencode.yml` i din repo. Sørg for at indstille de relevante `model` og nødvendige API-nøgler 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. **Opbevar API-nøglerne i hemmeligheder**
  56. I din organisation eller dit projekt **indstillinger** skal du udvide **Hemmeligheder og variabler** til venstre og vælge **Handlinger**. Og tilføj de nødvendige API-nøgler.
  57. ---
  58. ## Konfiguration
  59. - `model`: Den model, der skal bruges med OpenCode. Antager formatet `provider/model`. Dette er **påkrævet**.
  60. - `agent`: Agenten, der skal bruges. Skal være en primær agent. Falder tilbage til `default_agent` fra config eller `"build"`, hvis den ikke findes.
  61. - `share`: Om OpenCode-sessionen skal dele. Standard er **true** for offentlige arkiver.
  62. - `prompt`: Valgfri brugerdefineret prompt for at tilsidesætte standardadfærden. Brug dette til at tilpasse, hvordan OpenCode behandler anmodninger.
  63. - `token`: Valgfrit GitHub adgangstoken til at udføre operationer såsom oprettelse af kommentarer, begå ændringer og åbning af Pull Requests. Som standard bruger OpenCode installationsadgangstokenet fra OpenCode GitHub-appen, så commits, kommentarer og Pull Requests ser ud til at komme fra appen.
  64. Alternativt kan du bruge GitHub Action runners [built-in `GITHUB_TOKEN`](OpenCode) uden at installere OpenCode GitHub appen. Bare sørg for at give de nødvendige tilladelser i dit workflow:
  65. ```yaml
  66. permissions:
  67. id-token: write
  68. contents: write
  69. pull-requests: write
  70. issues: write
  71. ```
  72. Du kan også bruge en [personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)(PAT), hvis det foretrækkes.
  73. ---
  74. ## Understøttede begivenheder
  75. OpenCode kan udløses af følgende GitHub hændelser:
  76. | Begivenhedstype | Udløst af | Detaljer |
  77. | ----------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
  78. | `issue_comment` | Kommentarer og problemer eller PR | Nævn `/opencode` eller `/oc` i din kommentar. OpenCode læser kontekst og kan oprette brancher, åbne PR'er eller svare. |
  79. | `pull_request_review_comment` | Kommenter specifikke kodelinjer i en PR | Nævn `/opencode` eller `/oc`, mens du gennemgår koden. OpenCode modtager filsti, linjenumre og diff-kontekst. |
  80. | `issues` | Udgave åbnet eller redigeret | Udløs automatisk OpenCode, når problemer oprettes eller ændres. Kræver `prompt` input. |
  81. | `pull_request` | PR åbnet eller opdateret | Udløs automatisk OpenCode, når PR'er åbnes, synkroniseres eller genåbnes. Nyttigt til automatiserede kodegennemgange. |
  82. | `schedule` | Cron-baseret tidsplan | Kør OpenCode efter en tidsplan. Kræver `prompt` input. Output går til logfiler og PR'er (intet problem ved kommentere). |
  83. | `workflow_dispatch` | Manuel trigger fra GitHub UI | Udløs OpenCode efter behov via fanen Handlinger. Kræver `prompt` input. Output går til logfiler og PR'er. |
  84. ### Tidsplan eksempel
  85. Kør OpenCode efter en tidsplan for at udføre automatiske opgaver:
  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 begivenheder er `prompt` input **påkrævet**, da der ikke er nogen kommentarer at udtrække instruktioner fra. Planlagte arbejdsgange kører uden en brugerkontekst til kontrol af tilladelser, så arbejdsgangen skal give `contents: write` og `pull-requests: write`, hvis du forventer, at OpenCode skal oprette brancher eller PR'er.
  115. ---
  116. ### Pull Request eksempel
  117. Gennemgå automatisk PR'er, når de åbnes eller opdateres:
  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` hændelser, hvis der ikke er angivet nogen `prompt`, vil OpenCode som standard gennemgå Pull Requesten.
  149. ---
  150. ### Issues Triage eksempel
  151. Triage automatisk nye problemer. Dette eksempel filtrerer til konti ældre end 30 dage for at reducere 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` begivenheder er `prompt` input **påkrævet**, da der ikke er nogen kommentarer at udtrække instruktioner fra.
  195. ---
  196. ## Brugerdefinerede prompter
  197. Tilsidesæt standardprompten for at tilpasse OpenCodes adfærd til din arbejdsgang.
  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 nyttigt til at håndhæve specifikke gennemgangskriterier, kodningsstandarder eller fokusområder, der er relevante for dit projekt.
  209. ---
  210. ## Eksempler
  211. Her er nogle eksempler på, hvordan du kan bruge OpenCode i GitHub.
  212. - **Forklar et problem**
  213. Tilføj denne kommentar i et GitHub-nummer.
  214. ```
  215. /opencode explain this issue
  216. ```
  217. OpenCode vil læse hele tråden, inklusive alle kommentarer, og svare med en klar forklaring.
  218. - **Løs et problem**
  219. I et GitHub-problem skal du sige:
  220. ```
  221. /opencode fix this
  222. ```
  223. Og OpenCode vil oprette en ny branch, implementere ændringer og åbne en PR med ændringer.
  224. - **Gennemgå PR'er og foretag ændringer**
  225. Efterlad følgende kommentar på en GitHub PR.
  226. ```
  227. Delete the attachment from S3 when the note is removed /oc
  228. ```
  229. OpenCode vil implementere den ønskede ændring og forpligtelse til den samme PR.
  230. - **Gennemgå specifikke kodelinjer**
  231. Efterlad en kommentar direkte på kodelinjer i PR's faneblad "Filer". OpenCode detekterer automatisk filer, linjenumrene og diff-konteksten for at give præcise svar.
  232. ```
  233. [Comment on specific lines in Files tab]
  234. /oc add error handling here
  235. ```
  236. Når du kommenterer på specifikke linjer, modtager OpenCode:
  237. - Den nøjagtige fil bliver gennemgået
  238. - De specifikke kodelinjer
  239. - Den omgivende forskellig kontekst
  240. - Linjenummeroplysninger
  241. Dette giver mulighed for mere målrettede anmodninger uden at skulle angive filstier eller linjenumre manuelt.