GitHub Action

Diese Seite erklärt den PR Report, der in GitHub Pull Requests erscheint. Wenn du zuerst nur das lokale CLI-Setup abschließen willst, starte mit Installation; komm hierher zurück, wenn Reviewer die Agent-Note-Zusammenfassung sehen sollen.

Schnellstart

Führe das einmal in deinem Repository aus:

npx agent-note init --agent claude

Damit wird der Workflow für den PR-Bericht erstellt:

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

Damit ist alles bereit. Jede PR erhält einen KI-Sitzungsbericht.

Eingaben

Input	Standard	Beschreibung
`base`	Basis-Branch der PR	Branch, gegen den verglichen wird
`pr_output`	`description`	Ziel des PR-Berichts: `description`, `comment` oder `none`
`prompt_detail`	`compact`	Detailgrad der Prompt-Historie im PR-Bericht: `compact` hält den Bericht fokussiert, `full` zeigt alle gespeicherten Prompts
`dashboard`	`false`	Führt den Dashboard-Modus statt des PR-Report-Modus aus. Normalerweise durch `agent-note init --dashboard` generiert

Dashboard

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

Ausgaben

Output	Typ	Beschreibung
`overall_ai_ratio`	number	AI Ratio über die gesamte PR (0-100)
`overall_method`	string	`line`, `file`, `mixed` oder `none`
`tracked_commits`	number	Anzahl der Commits mit agent-note Daten
`total_commits`	number	Gesamtzahl der Commits in der PR
`total_prompts`	number	Gesamtzahl der Prompts über alle Commits
`json`	string	Vollständiger strukturierter Bericht
`markdown`	string	Gerenderter Markdown-Bericht
`should_deploy`	boolean string	Output im Dashboard-Modus, das dem aufrufenden Workflow sagt, ob Pages veröffentlicht werden soll

Bericht

Der PR-Bericht enthält:

Header — Total AI Ratio mit Balken sowie darunter Model
Reviewer Context — versteckter Markdown-Kommentar für AI Review Tools, erzeugt aus generischen Gruppen geänderter Bereiche, Review-Fokus und den neuesten relevanten Intent-Signalen
Tabelle — AI Ratio, Prompt-Anzahl und Dateien pro Commit
Prompts — einklappbare 📝 Context-, 🧑 Prompt- und 🤖 Response-Einträge pro Commit

AI Review Tools

Der Reviewer Context wird als versteckter Markdown-Kommentar im PR body gespeichert. Menschliche Reviewer sehen den normalen Bericht, während Tools, die die rohe PR Description lesen, den zusätzlichen Kontext nutzen können.

Dieser Kontext ist deterministisch. Er fasst geänderte Bereiche, Review-Fokus und die neuesten relevanten Intent-Signale aus Agent Note Daten zusammen. Tools wie Copilot, CodeRabbit, Devin und Greptile können dadurch verstehen, warum sich die PR geändert hat, bevor sie den Diff prüfen.

Er ist trotzdem nur Orientierung, kein Beweis. Review Tools sollten den Kontext immer mit dem tatsächlichen Diff, den Tests und dem Code vergleichen.

Nächster Schritt

Wenn du zusätzlich eine gemeinsame Pages-Ansicht für offene und gemergte PRs möchtest, geh weiter zur Seite Dashboard.