GitHub Action

This page is for the PR Report that appears inside GitHub Pull Requests. If you only want the local CLI setup, finish Installation first; come back here when you want reviewers to see the Agent Note summary.

Quick Setup

Run this once in your repository:

npx agent-note init --agent claude

That creates the PR Report workflow for you:

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

That’s it. Every PR gets an AI session report.

Inputs

Input	Default	Description
`base`	PR base branch	Base branch to compare against
`pr_output`	`description`	PR Report destination: `description`, `comment`, or `none`
`prompt_detail`	`compact`	Prompt history detail in PR Report: `compact` keeps the report focused, `full` shows every stored prompt
`dashboard`	`false`	Run Dashboard Mode instead of PR Report Mode. Usually generated by `agent-note init --dashboard`

Post as comment instead of description

- uses: wasabeef/AgentNote@v1
  with:
    pr_output: comment
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Add Dashboard later

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

Outputs

Output	Type	Description
`overall_ai_ratio`	number	PR-wide AI Ratio (0-100)
`overall_method`	string	`line`, `file`, `mixed`, or `none`
`tracked_commits`	number	Commits with agent-note data
`total_commits`	number	Total commits in PR
`total_prompts`	number	Total prompts across all commits
`json`	string	Full structured report
`markdown`	string	Rendered markdown report
`should_deploy`	boolean string	Dashboard Mode output that tells the caller workflow whether Pages should publish

Use outputs in workflow

- uses: wasabeef/AgentNote@v1
  id: agent-note
  with:
    base: main

- run: echo "Total AI Ratio: ${{ steps.agent-note.outputs.overall_ai_ratio }}%"

Report Format

The PR Report includes:

Header — Total AI Ratio with a progress bar, plus a separate plain-text Model line
Reviewer Context — a hidden Markdown comment for AI Review tools, built from generic changed-area groups, review focus, and the latest relevant author intent signals
Table — per-commit AI Ratio, prompt count, and files with attribution
Prompts — collapsible section with per-commit 📝 Context, 🧑 Prompt, and 🤖 Response entries

AI Review Tools

The Reviewer Context block is stored as a hidden Markdown comment in the PR body. Human reviewers see the normal report, while tools that read the raw PR description can use the extra context.

That context is deterministic. It summarizes changed areas, review focus, and the latest relevant author intent signals from Agent Note data. Tools such as Copilot, CodeRabbit, Devin, and Greptile can use it to understand why the PR changed before they review the diff.

It is still guidance, not proof. Review tools should compare the context with the actual diff, tests, and code.

The action fetches refs/notes/agentnote from the remote. The pre-push git hook installed by agent-note init auto-pushes notes on every git push — no manual push needed.

Next Step

If you want a shared Pages view for open and merged PR history, continue to the Dashboard guide.

If the report is empty or prompts look shorter than expected, see Troubleshooting.