GitHub Action
Esta página trata del PR Report que aparece en las Pull Requests de GitHub. Si solo quieres terminar el setup local del CLI, empieza por Instalación; vuelve aquí cuando los reviewers deban ver el resumen de Agent Note.
Configuración rápida
Sección titulada «Configuración rápida»Ejecuta esto una vez en tu repositorio:
npx agent-note init --agent claudeCon esto se crea el workflow del informe para 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 }}Y ya está. Cada PR recibe un informe de sesión de IA.
| Input | Default | Descripción |
|---|---|---|
base | Rama base del PR | Rama contra la que se compara |
pr_output | description | Destino del informe del PR: description, comment o none |
prompt_detail | compact | Nivel de detalle del historial de prompts en el informe del PR: compact mantiene el informe enfocado, full muestra todos los prompts guardados |
dashboard | false | Ejecuta el modo Dashboard en lugar del modo PR Report. Normalmente lo genera agent-note init --dashboard |
Dashboard
Sección titulada «Dashboard»npx agent-note init --agent claude --dashboardOutputs
Sección titulada «Outputs»| Output | Tipo | Descripción |
|---|---|---|
overall_ai_ratio | number | AI Ratio total del PR (0-100) |
overall_method | string | line, file, mixed o none |
tracked_commits | number | Número de commits con datos de agent-note |
total_commits | number | Número total de commits en el PR |
total_prompts | number | Número total de prompts en todos los commits |
json | string | Reporte estructurado completo |
markdown | string | Reporte renderizado en Markdown |
should_deploy | boolean string | Output del modo Dashboard que indica al workflow llamador si debe publicar Pages |
Qué incluye el reporte
Sección titulada «Qué incluye el reporte»El reporte del PR incluye:
- Header —
Total AI Ratiocon barra y, debajo,Model - Reviewer Context — comentario Markdown oculto para herramientas de AI Review, generado a partir de grupos genéricos de áreas cambiadas, foco de review y las señales de intención relevantes más recientes
- Tabla — AI Ratio, cantidad de prompts y archivos por commit
- Prompts — entradas
📝 Context,🧑 Prompty🤖 Responsepor commit en una sección plegable
AI Review tools
Sección titulada «AI Review tools»El Reviewer Context se guarda como comentario Markdown oculto en el PR body. Los reviewers humanos ven el reporte normal, mientras que las herramientas que leen la descripción bruta del PR pueden usar ese contexto adicional.
Ese contexto es determinístico. Resume áreas cambiadas, foco de review y las últimas señales de intención relevantes desde los datos de Agent Note. Herramientas como Copilot, CodeRabbit, Devin y Greptile pueden usarlo para entender por qué cambió el PR antes de revisar el diff.
Sigue siendo orientación, no una prueba. Las herramientas de review deben comparar el contexto con el diff real, los tests y el código.
Siguiente paso
Sección titulada «Siguiente paso»Si además quieres una vista compartida en Pages para PR abiertas y mergeadas, sigue con Dashboard.