Dashboard

できること

Dashboard は、Agent Note の履歴をチームで共有するための 1 つの URL です。

Open / Merged 両方の PR 履歴を 1 か所で見られる
Commit、Prompt、Attribution をまとめてたどれる
Agent Note が reference や scope を復元できた場合、短い prompt の前に表示専用 📝 Context が出る
GitHub Pages の /dashboard/ 配下に 1 つの共有 URL として公開できる

PR Description だけでは足りず、チーム向けの一覧画面がほしいときに使います。

先に決めること

Dashboard はチームで共有する画面が必要なときだけ使います。

PR の中に AI レポートが出れば十分なら、GitHub Action だけで OK です。
Open / Merged 履歴をまとめて見たいなら、このページの設定を足します。

クイックセットアップ

まずは 1 回だけ次を実行します。

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

生成された 2 本の workflow をコミットします。

git add .github/workflows/agentnote-pr-report.yml .github/workflows/agentnote-dashboard.yml
git commit -m "chore: enable agent-note dashboard"
git push

GitHub の Pages 設定で、公開元に GitHub Actions を選びます。

生成された Dashboard workflow は、wasabeef/AgentNote@v1 に dashboard: true を渡して、復元・同期・build・artifact upload・note 保存を実行し、共有用の /dashboard/ を公開します。同じ job に既存の GitHub Pages artifact upload がある場合は、既存 site を置き換えず、その artifact の dashboard/ 配下に Dashboard を追加します。別 job / workflow がすでに Pages を公開している場合は、上書きを避けるため standalone publish を skip します。docs site と Dashboard をまとめる場合は、actions/upload-pages-artifact より前の同じ job に Agent Note を置いてください。

公開 URL

通常は次の URL に公開します。

https://<owner>.github.io/<repo>/dashboard/

たとえば:

https://wasabeef.github.io/AgentNote/dashboard/

PR Preview

リポジトリの github-pages environment で Pull Request Deploy を許可していれば、merge 前でも共有 Dashboard に Open 状態の PR を表示できます。

pull_request の run で現在の Open 状態を公開
default branch への push で Merged 状態に置き換え
environment protection で Pull Request Deploy が止まる場合は、merge 後に共有 Dashboard が更新されます

ここは Agent Note 自体ではなく、リポジトリ側の GitHub Pages environment 設定に依存します。

最初の deploy

新しいリポジトリでも、Dashboard が最初に公開される前から Dashboard データ自体は蓄積できます。Pull Request Deploy が許可されていれば、最初の pull_request run が成功した時点で共有 Pages URL が作られます。許可されていない場合は、default branch からの最初の deploy 成功後に作られます。

仕組み

refs/notes/agentnote が source of truth のまま残ります
Dashboard Mode の wasabeef/AgentNote@v1 が gh-pages/dashboard/notes/*.json を共有用の保存先として更新します
GitHub Pages が /dashboard/ で build 済み Dashboard を配信します

リポジトリ自体には Dashboard 用の sample JSON をコミットしません。新しい Dashboard は workflow が note file を復元または生成するまで空です。pull_request で Open 状態を公開し、default branch への push で Merged 状態に置き換えます。

データが表示されないとき

Dashboard は、空の状態でも原因の候補を表示します。まずは次を確認してください。

まったく data がない: Agent Note を有効化したあとに PR workflow が実行されたか、Dashboard workflow が成功したか、refs/notes/agentnote が push されているかを確認します。
?pr=<number> で data がない: その PR の workflow がまだ実行されていない、GitHub Pages の environment protection で Pull Request Deploy が止まっている、または URL の PR 番号が公開済み Dashboard data と一致していない可能性があります。
?commit=<sha> で data がない: その Commit に Agent Note entry がない、notes がまだ push されていない、または別リポジトリの SHA を見ている可能性があります。

ページは開くのに data が出ない場合は Troubleshooting を確認してください。