GitHub

Use o OpenCode em issues e pull requests do GitHub.

O OpenCode integra-se ao seu fluxo de trabalho do GitHub. Mencione /opencode ou /oc em seu comentario, e o OpenCode executara tarefas dentro do seu runner do GitHub Actions.

Recursos

• Triagem de issues: Peca ao OpenCode para investigar um issue e explica-lo para voce.
• Corrigir e implementar: Peca ao OpenCode para corrigir um issue ou implementar um recurso. Ele trabalhara em um novo branch e enviara um PR com todas as alteracoes.
• Seguro: O OpenCode e executado dentro dos seus runners do GitHub.

Instalacao

Execute o seguinte comando em um projeto que esta em um repositorio do GitHub:

opencode github install

Isso guiara voce pela instalacao do app do GitHub, criacao do workflow e configuracao de secrets.

Configuracao Manual

Ou voce pode configura-lo manualmente.

1. Instalar o app do GitHub

   Va para github.com/apps/opencode-agent (opens in a new tab). Certifique-se de que esta instalado no repositorio de destino.

2. Adicionar o workflow

   Adicione o seguinte arquivo de workflow em .github/workflows/opencode.yml no seu repositorio. Certifique-se de definir o model apropriado e as chaves de API necessarias em env.

   .github/workflows/opencode.yml

   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. Armazenar as chaves de API em secrets

   Nas configuracoes da sua organizacao ou projeto, expanda Secrets and variables a esquerda e selecione Actions. Em seguida, adicione as chaves de API necessarias.

Configuracao

• model: O modelo a ser usado com o OpenCode. Usa o formato provider/model. Isso e obrigatorio.

• agent: O agente a ser usado. Deve ser um agente primario. Recorre ao default_agent da configuracao ou "build" se nao encontrado.

• share: Se deve compartilhar a sessao do OpenCode. Padrao e true para repositorios publicos.

• prompt: Prompt personalizado opcional para substituir o comportamento padrao. Use isso para personalizar como o OpenCode processa solicitacoes.

• token: Token de acesso do GitHub opcional para realizar operacoes como criar comentarios, fazer commits de alteracoes e abrir pull requests. Por padrao, o OpenCode usa o token de acesso de instalacao do App do GitHub do OpenCode, entao commits, comentarios e pull requests aparecem como vindos do app.

  Alternativamente, voce pode usar o GITHUB_TOKEN integrado (opens in a new tab) do runner do GitHub Action sem instalar o App do GitHub do OpenCode. Apenas certifique-se de conceder as permissoes necessarias no seu workflow:

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

  Voce tambem pode usar tokens de acesso pessoal (opens in a new tab) (PAT) se preferir.

Eventos Suportados

O OpenCode pode ser acionado pelos seguintes eventos do GitHub:

Exemplo de Agendamento

Execute o OpenCode em um agendamento para realizar tarefas automatizadas:

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.

Para eventos agendados, a entrada de prompt e obrigatoria ja que nao ha comentario do qual extrair instrucoes. Workflows agendados sao executados sem contexto de usuario para verificacao de permissoes, entao o workflow deve conceder contents: write e pull-requests: write se voce espera que o OpenCode crie branches ou PRs.

Exemplo de Pull Request

Revise automaticamente PRs quando sao abertos ou atualizados:

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

Para eventos pull_request, se nenhum prompt for fornecido, o OpenCode revisa o pull request por padrao.

Exemplo de Triagem de Issues

Triagem automatica de novos issues. Este exemplo filtra contas com mais de 30 dias para reduzir 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.

Para eventos issues, a entrada de prompt e obrigatoria ja que nao ha comentario do qual extrair instrucoes.

Prompts Personalizados

Substitua o prompt padrao para personalizar o comportamento do OpenCode para seu workflow.

- 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

Isso e util para aplicar criterios de revisao especificos, padroes de codificacao ou areas de foco relevantes para seu projeto.

Exemplos

Aqui estao alguns exemplos de como voce pode usar o OpenCode no GitHub.

• Explicar um issue

  Adicione este comentario em um issue do GitHub.

  /opencode explain this issue

  O OpenCode lera toda a thread, incluindo todos os comentarios, e respondera com uma explicacao clara.

• Corrigir um issue

  Em um issue do GitHub, diga:

  /opencode fix this

  E o OpenCode criara um novo branch, implementara as alteracoes e abrira um PR com as alteracoes.

• Revisar PRs e fazer alteracoes

  Deixe o seguinte comentario em um PR do GitHub.

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

  O OpenCode implementara a alteracao solicitada e fara commit no mesmo PR.

• Revisar linhas de codigo especificas

  Deixe um comentario diretamente em linhas de codigo na aba "Files" do PR. O OpenCode detecta automaticamente o arquivo, numeros de linha e contexto do diff para fornecer respostas precisas.

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

  Ao comentar em linhas especificas, o OpenCode recebe:

  • O arquivo exato sendo revisado
  • As linhas de codigo especificas
  • O contexto do diff ao redor
  • Informacoes de numeros de linha

  Isso permite solicitacoes mais direcionadas sem precisar especificar caminhos de arquivo ou numeros de linha manualmente.