GitHub Action

このページは、GitHub の Pull Request に表示される PR Report の設定です。まず local の CLI setup だけ済ませたい場合はインストールを先に読み、reviewer に Agent Note の summary を見せたい段階で戻ってきてください。

クイックセットアップ

まずはリポジトリで次を 1 回実行します。

npx agent-note init --agent claude

これで PR レポート用の workflow が作られます。

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

これだけで、すべての PR に AI セッションレポートが追加されます。

入力

入力	デフォルト	説明
`base`	PR のベースブランチ	比較対象のブランチ
`pr_output`	`description`	PR レポートの出力先: `description` / `comment` / `none`
`prompt_detail`	`compact`	PR レポートに出す prompt 履歴の細かさ: `compact` は説明に必要な prompt を中心に表示、`full` は保存された prompt すべて
`dashboard`	`false`	PR Report Mode の代わりに Dashboard Mode を実行します。通常は `agent-note init --dashboard` が生成します

Dashboard も使いたいとき

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

出力

出力	型	説明
`overall_ai_ratio`	number	PR 全体の AI Ratio (0-100)
`overall_method`	string	`line`, `file`, `mixed`, `none`
`tracked_commits`	number	agent-note データ付きのコミット数
`total_commits`	number	PR 内の全コミット数
`total_prompts`	number	全プロンプト数
`json`	string	構造化レポート全体
`markdown`	string	レンダリング済みのマークダウンレポート
`should_deploy`	boolean string	Dashboard Mode で Pages を公開するかどうかを caller workflow に伝えます

レポート形式

PR レポートには次が入ります。

Header — Total AI Ratio と bar、その下に Model
Reviewer Context — AI Review tool 向けの hidden Markdown comment。汎用的な changed area、review focus、直近の関連 intent signals から作ります
Table — commit ごとの AI Ratio、prompt 数、attribution 付き files
Prompts — commit ごとの 📝 Context、🧑 Prompt、🤖 Response を折りたたんで表示

AI Review tool との連携

Reviewer Context は PR body の hidden Markdown comment として保存されます。人間の reviewer には通常の report だけが見え、raw PR description を読む AI Review tool は追加の context を使えます。

この context は Agent Note data から決定的に作られます。changed area、review focus、直近の関連 intent signals をまとめるため、Copilot、CodeRabbit、Devin、Greptile などが diff を読む前に「なぜ変更されたか」を理解しやすくなります。

ただし proof ではありません。review tool は必ず実際の diff、test、code と照らし合わせるべきです。

次のステップ

Open / Merged の PR 履歴を 1 つの Pages URL で見たいなら、続けて Dashboard を読んでください。

レポートが空、または prompt が想定より少ない場合は Troubleshooting を確認してください。