GitHub Action

Esta página trata do PR Report exibido nas Pull Requests do GitHub. Se você só quer concluir o setup local do CLI, comece por Instalação; volte aqui quando reviewers precisarem ver o summary do Agent Note.

Configuração rápida

Execute isto uma vez no seu repositório:

npx agent-note init --agent claude

Isso cria o workflow de relatório de PR para você:

.github/workflows/agentnote-pr-report.yml

name: Agent Note PR Report
on:
  pull_request:
    types: [opened, reopened, synchronize]
permissions:
  contents: read
  pull-requests: write
jobs:
  report:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - uses: wasabeef/AgentNote@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Pronto. Toda PR passa a receber um relatório de sessão de IA.

Inputs

Input	Default	Descrição
base	Branch base da PR	Branch usada para comparação
pr_output	description	Destino do relatório da PR: description, comment ou none
prompt_detail	compact	Nível de detalhe do histórico de prompts no relatório da PR: compact mantém o relatório focado, full mostra todos os prompts salvos
dashboard	false	Executa o modo Dashboard em vez do modo PR Report. Normalmente gerado por agent-note init --dashboard

Dashboard

npx agent-note init --agent claude --dashboard

Dica

Isso também adiciona .github/workflows/agentnote-dashboard.yml para configurar o Dashboard compartilhado.

Outputs

Output	Tipo	Descrição
overall_ai_ratio	number	Razão de IA do PR inteiro (0-100)
overall_method	string	line, file, mixed ou none
tracked_commits	number	Número de commits com dados de agent-note
total_commits	number	Número total de commits no PR
total_prompts	number	Número total de prompts em todos os commits
json	string	Relatório estruturado completo
markdown	string	Relatório em Markdown já renderizado
should_deploy	boolean string	Output do modo Dashboard que informa ao workflow chamador se Pages deve ser publicado

O que o relatório inclui

O relatório do PR inclui:

• Header — Total AI Ratio com barra e, abaixo, Model
• Reviewer Context — comentário Markdown oculto para ferramentas de AI Review, criado a partir de grupos genéricos de áreas alteradas, foco de review e sinais de intenção recentes e relevantes
• Tabela — razão de IA, quantidade de prompts e arquivos por commit
• Prompts — entradas 📝 Context, 🧑 Prompt e 🤖 Response por commit em uma seção recolhível

Dica

Os hashes de commit do relatório apontam diretamente para a página do commit no GitHub.

AI Review tools

O Reviewer Context é salvo como comentário Markdown oculto no PR body. Reviewers humanos veem o relatório normal, enquanto ferramentas que leem a raw PR description podem usar esse contexto extra.

Esse contexto é determinístico. Ele resume áreas alteradas, foco de review e os sinais de intenção mais recentes e relevantes a partir dos dados do Agent Note. Copilot, CodeRabbit, Devin e Greptile podem usá-lo para entender por que a PR mudou antes de revisar o diff.

Ainda é orientação, não prova. Ferramentas de review devem comparar o contexto com o diff real, os testes e o código.

Próximo passo

Se você também quiser uma visão compartilhada em Pages para PRs abertas e mergeadas, siga para Dashboard.