跳到內容

Dashboard

Agent Note dashboard preview

Dashboard 會給團隊一個共享 URL,用來查看 Agent Note 的歷史記錄。

  • 在同一個地方查看 open 與 merged 的 PR 歷史
  • 不用逐一打開 PR,也能查看 commit、prompt 與 attribution
  • 當 Agent Note 可以還原 reference 或 scope 時,在短 prompt 前顯示只用於展示的 📝 Context
  • 一個共享的 GitHub Pages URL,通常位於 /dashboard/

當 PR 報告已經不夠用,而團隊需要一個共同查看的頁面時,就適合使用 Dashboard。

只有在你需要共享的網頁視圖時,才需要 Dashboard。

  • 如果 pull request 裡的 AI 會話報告已經夠用,就停在 GitHub Action
  • 如果你想要一個共享的 Pages 視圖來查看 open 與 merged 歷史,就繼續看這裡。
  1. 先執行一次 Dashboard setup。
Terminal window
npx agent-note init --agent claude --dashboard
  1. 提交這兩個 workflow 檔案。
Terminal window
git add .github/workflows/agentnote-pr-report.yml .github/workflows/agentnote-dashboard.yml
git commit -m "chore: enable agent-note dashboard"
git push
  1. 在 GitHub Pages 中,把 source 設為 GitHub Actions

生成的 Dashboard workflow 會用 wasabeef/AgentNote@v1 並傳入 dashboard: true,執行還原、同步、build、artifact 上傳與 note 持久化,然後把共享視圖發布到 /dashboard/。如果同一個 job 已經上傳 GitHub Pages artifact,Agent Note 會把 Dashboard 加到該 artifact 的 dashboard/ 目錄,而不是取代現有網站。如果另一個 job 或 workflow 已經發布 Pages,Agent Note 會跳過 standalone 發布;要合併 docs site 和 Dashboard,請把 Agent Note 放在同一個 job 中,並放在 actions/upload-pages-artifact 之前。

通常 Dashboard 會發佈在這裡:

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

例如:

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

即使是全新的儲存庫,也能在 Dashboard 第一次發布之前先累積 Dashboard 資料。如果允許 Pull Request Deploy,公開的 Pages URL 可以在第一次成功的 pull_request run 之後出現。否則,它會在 default branch 的第一次成功 deploy 之後出現。

  • refs/notes/agentnote 仍然是 Source of Truth
  • Dashboard Mode 的 wasabeef/AgentNote@v1 會把 note 快照寫入 gh-pages/dashboard/notes/*.json
  • GitHub Pages 會在 /dashboard/ 提供建置完成的 Dashboard

倉庫本身不會提交範例 Dashboard JSON。新的 Dashboard 會一直保持為空,直到 workflow 還原或產生 note file。pull_request 會發佈 Open 狀態,而推送到 default branch 後則會替換成 Merged 狀態。

Dashboard 現在會顯示可能原因,而不是只提示缺少資料。

  • 完全沒有資料:確認啟用 Agent Note 後是否跑過 PR workflow、Dashboard workflow 是否成功、refs/notes/agentnote 是否已經 push。
  • ?pr=<number> 沒有資料:該 PR 的 workflow 可能還沒執行,GitHub Pages environment protection 可能阻止了 Pull Request Deploy,或 URL 裡的 PR 編號不屬於已發布的 Dashboard data。
  • ?commit=<sha> 沒有資料:該 Commit 可能沒有 Agent Note entry,notes 可能還沒 push,或這個 SHA 來自另一個儲存庫。

如果頁面能開啟但仍然空白,請查看 Troubleshooting