GitHub

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.

Funksjoner

• Triage saker: Be OpenCode se på en sak og forklare den for deg.
• 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.
• Sikkert: OpenCode kjører i GitHub-runners.

Installasjon

Kjør følgende kommando i et prosjekt som er et GitHub-repo:

opencode github install

Dette vil lede deg gjennom å installere GitHub-appen, lage arbeidsflyten og sette opp secrets (hemmeligheter).

Manuelt oppsett

Eller du kan sette den opp manuelt.

1. Installer GitHub-appen

   Gå over til github.com/apps/opencode-agent. Sørg for at den er installert på mållageret.

2. Legg til arbeidsflyten

   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.

   ymlCopy

   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. Lagre API-nøklene i hemmeligheter

   Utvid Hemmeligheter og variabler til venstre i innstillingene for organisasjonen eller prosjektet og velg Actions. Og legg til de nødvendige API-nøklene.

Konfigurasjon

• model: Modellen som skal brukes med OpenCode. Tar formatet provider/model. Dette er obligatorisk.

• agent: Agenten som skal brukes. Må være en primær agent. Faller tilbake til default_agent fra config eller "build" hvis ikke funnet.

• share: Om OpenCode-økten skal deles. Standard er true for offentlige depoter.

• prompt: Valgfri egendefinert melding for å overstyre standard oppførsel. Bruk dette til å tilpasse hvordan OpenCode behandler forespørsler.

• 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.

  Alternativt kan du bruke GitHub Action-løperens innebygde GITHUB_TOKEN uten å installere OpenCode GitHub-appen. Bare sørg for å gi de nødvendige tillatelsene i arbeidsflyten din:

  yamlCopy

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

  Du kan også bruke en personlig tilgangstoken(PAT) hvis foretrukket.

Støttede hendelser

OpenCode kan utløses av følgende GitHub-hendelser:

Eksempel på tidsplan

Kjør OpenCode på en tidsplan for å utføre automatiserte oppgaver:

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.

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.

Eksempel på Pull Request

Gjennomgå PR-er automatisk når de åpnes eller oppdateres:

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

For pull_request-hendelser, hvis ingen prompt er oppgitt, går OpenCode som standard gjennom PR-en.

Eksempel på triage av saker

Automatisk triage av nye saker. Dette eksemplet filtrerer til kontoer eldre enn 30 dager for å redusere spam:

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.

For issues-hendelser er prompt-inngangen påkrevd siden det ikke er noen kommentarer å trekke ut instruksjoner fra.

Egendefinerte prompter

Overstyr standardprompten for å tilpasse oppførselen til OpenCode for arbeidsflyten din.

- 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

Dette er nyttig for å håndheve spesifikke vurderingskriterier, kodestandarder eller fokusområder som er relevante for prosjektet ditt.

Eksempler

Her er noen eksempler på hvordan du kan bruke OpenCode i GitHub.

:::tip Du kan konfigurere til å bruke en annen triggerfrase enn @opencode. :::

• Forklar en sak (issue)

  Legg til denne kommentaren i en GitHub-sak.

  Copy

  /opencode explain this issue
  

  OpenCode vil lese hele tråden, inkludert alle kommentarer, og svare med en tydelig forklaring.

• Fiks en sak

  I en GitHub-sak, si:

  Copy

  /opencode fix this
  

  Og OpenCode vil opprette en ny gren, implementere endringene og åpne en PR med endringene.

• Se gjennom PR-er og gjør endringer

  Legg igjen følgende kommentar på en GitHub PR.

  Copy

  Delete the attachment from S3 when the note is removed /oc
  

  OpenCode vil implementere den forespurte endringen og committe den til samme PR.

• Review av spesifikke kodelinjer

  Legg igjen en kommentar direkte på kodelinjer i PRs "Filer"-fane. OpenCode oppdager automatisk filen, linjenumrene og diff-konteksten for å gi presise svar.

  Copy

  [Comment on specific lines in Files tab]
  /oc add error handling here
  

  Når du kommenterer spesifikke linjer, mottar OpenCode:

  • Den nøyaktige filen blir gjennomgått
  • De spesifikke kodelinjene
  • Den omkringliggende diff-konteksten
  • Linjenummerinformasjon

  Dette gir mulighet for mer målrettede forespørsler uten å måtte spesifisere filstier eller linjenumre manuelt.