GitHub Action
Cette page concerne le PR Report affiché dans les Pull Requests GitHub. Si vous voulez seulement terminer le setup local du CLI, commencez par Installation ; revenez ici quand les reviewers doivent voir le résumé Agent Note.
Mise en place rapide
Section intitulée « Mise en place rapide »Exécutez ceci une fois dans votre dépôt :
npx agent-note init --agent claudeCela crée pour vous le workflow de rapport de PR :
name: Agent Note PR Reporton: pull_request: types: [opened, reopened, synchronize]permissions: contents: read pull-requests: writejobs: report: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 with: fetch-depth: 0 - uses: wasabeef/AgentNote@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}C’est tout. Chaque PR reçoit un rapport de session IA.
| Input | Valeur par défaut | Description |
|---|---|---|
base | Branche de base de la PR | Branche utilisée pour la comparaison |
pr_output | description | Destination du rapport de PR : description, comment ou none |
prompt_detail | compact | Niveau de détail de l’historique des prompts dans le rapport de PR : compact garde le rapport ciblé, full affiche tous les prompts enregistrés |
dashboard | false | Exécute le mode Dashboard au lieu du mode PR Report. Généralement généré par agent-note init --dashboard |
Dashboard
Section intitulée « Dashboard »npx agent-note init --agent claude --dashboard| Output | Type | Description |
|---|---|---|
overall_ai_ratio | number | AI Ratio sur l’ensemble de la PR (0-100) |
overall_method | string | line, file, mixed ou none |
tracked_commits | number | Nombre de commits avec des données agent-note |
total_commits | number | Nombre total de commits dans la PR |
total_prompts | number | Nombre total de prompts sur tous les commits |
json | string | Rapport structuré complet |
markdown | string | Rapport Markdown rendu |
should_deploy | boolean string | Output du mode Dashboard qui indique au workflow appelant si Pages doit être publié |
Ce que contient le rapport
Section intitulée « Ce que contient le rapport »Le rapport de PR contient :
- Header —
Total AI Ratioavec une barre, puisModelen dessous - Reviewer Context — commentaire Markdown masqué pour les outils d’AI Review, construit à partir de groupes génériques de zones modifiées, du focus de review et des derniers signaux d’intention pertinents
- Tableau — AI Ratio, nombre de prompts et fichiers par commit
- Prompts — entrées
📝 Context,🧑 Promptet🤖 Responsepar commit dans une section repliable
Outils d’AI Review
Section intitulée « Outils d’AI Review »Le Reviewer Context est stocké comme commentaire Markdown masqué dans le body de la PR. Les reviewers humains voient le rapport normal, tandis que les outils qui lisent la description brute de la PR peuvent utiliser ce contexte supplémentaire.
Ce contexte est déterministe. Il résume les zones modifiées, le focus de review et les derniers signaux d’intention pertinents issus des données Agent Note. Des outils comme Copilot, CodeRabbit, Devin et Greptile peuvent s’en servir pour comprendre pourquoi la PR a changé avant de relire le diff.
Cela reste une aide, pas une preuve. Les outils de review doivent comparer ce contexte avec le diff réel, les tests et le code.
Étape suivante
Section intitulée « Étape suivante »Si vous voulez aussi une vue Pages partagée pour les PR ouvertes et mergées, continuez avec Dashboard.