Salta ai contenuti

GitHub Action

Questa pagina riguarda il PR Report che appare nelle Pull Request GitHub. Se vuoi completare solo il setup locale del CLI, inizia da Installazione; torna qui quando i reviewer devono vedere il riepilogo Agent Note.

Esegui questo comando una volta nel tuo repository:

Terminal window
npx agent-note init --agent claude

Così viene creato il workflow del report per la PR:

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

Fatto. Ogni PR riceve un report della sessione AI.

InputDefaultDescrizione
baseBranch base della PRBranch usato per il confronto
pr_outputdescriptionDestinazione del report della PR: description, comment o none
prompt_detailcompactDettaglio della cronologia dei prompt nel report della PR: compact mantiene il report mirato, full mostra tutti i prompt salvati
dashboardfalseEsegue la modalità Dashboard invece della modalità PR Report. Di solito viene generato da agent-note init --dashboard
Terminal window
npx agent-note init --agent claude --dashboard
OutputTipoDescrizione
overall_ai_rationumberAI Ratio sull’intera PR (0-100)
overall_methodstringline, file, mixed o none
tracked_commitsnumberNumero di commit con dati agent-note
total_commitsnumberNumero totale di commit nella PR
total_promptsnumberNumero totale di prompt su tutti i commit
jsonstringReport strutturato completo
markdownstringReport Markdown renderizzato
should_deployboolean stringOutput della modalità Dashboard che indica al workflow chiamante se pubblicare Pages

Il report della PR include:

  • HeaderTotal AI Ratio con barra, e sotto Model
  • Reviewer Context — commento Markdown nascosto per strumenti di AI Review, costruito da gruppi generici di aree modificate, focus di review e segnali d’intento recenti e pertinenti
  • Tabella — AI Ratio, numero di prompt e file per commit
  • Prompts — voci 📝 Context, 🧑 Prompt e 🤖 Response per commit in una sezione comprimibile

Il Reviewer Context viene salvato come commento Markdown nascosto nel body della PR. I reviewer umani vedono il report normale, mentre gli strumenti che leggono la descrizione grezza della PR possono usare quel contesto aggiuntivo.

Il contesto è deterministico. Riassume aree modificate, focus di review e gli ultimi segnali d’intento rilevanti dai dati Agent Note. Strumenti come Copilot, CodeRabbit, Devin e Greptile possono usarlo per capire perché la PR è cambiata prima di leggere il diff.

Resta comunque una guida, non una prova. Gli strumenti di review devono confrontarlo con il diff reale, i test e il codice.

Se vuoi anche una vista Pages condivisa per PR aperte e mergeate, continua con Dashboard.