GitHub Action

Halaman ini membahas PR Report yang muncul di GitHub Pull Request. Jika Anda hanya ingin menyelesaikan setup CLI lokal, mulai dari Instalasi; kembali ke sini saat reviewer perlu melihat summary Agent Note.

Quick setup

Jalankan ini sekali di repositori Anda:

npx agent-note init --agent claude

Perintah ini akan membuat workflow laporan PR:

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

Selesai. Setiap PR akan mendapatkan laporan sesi AI.

Inputs

Input	Default	Deskripsi
`base`	Branch dasar PR	Branch pembanding
`pr_output`	`description`	Tujuan laporan PR: `description`, `comment`, atau `none`
`prompt_detail`	`compact`	Tingkat detail riwayat prompt di laporan PR: `compact` menjaga laporan tetap fokus, `full` menampilkan semua prompt tersimpan
`dashboard`	`false`	Menjalankan mode Dashboard, bukan mode PR Report. Biasanya dibuat oleh `agent-note init --dashboard`

Dashboard

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

Outputs

Output	Tipe	Deskripsi
`overall_ai_ratio`	number	AI Ratio untuk seluruh PR (0-100)
`overall_method`	string	`line`, `file`, `mixed`, atau `none`
`tracked_commits`	number	Jumlah commit yang punya data agent-note
`total_commits`	number	Jumlah total commit dalam PR
`total_prompts`	number	Jumlah total prompt di semua commit
`json`	string	Laporan terstruktur lengkap
`markdown`	string	Laporan Markdown yang sudah dirender
`should_deploy`	boolean string	Output mode Dashboard yang memberi tahu workflow pemanggil apakah Pages perlu dipublikasikan

Isi laporan

Laporan PR berisi:

Header — Total AI Ratio dengan bar, lalu Model di bawahnya
Reviewer Context — komentar Markdown tersembunyi untuk AI Review tool, dibuat dari grup area perubahan yang umum, fokus review, dan sinyal niat terbaru yang relevan
Tabel — AI Ratio, jumlah prompt, dan file per commit
Prompts — entri 📝 Context, 🧑 Prompt, dan 🤖 Response per commit dalam bagian yang bisa dilipat

AI Review tool

Reviewer Context disimpan sebagai komentar Markdown tersembunyi di PR body. Reviewer manusia melihat laporan normal, sementara tool yang membaca raw PR description dapat memakai context tambahan ini.

Context ini deterministik. Isinya merangkum area yang berubah, fokus review, dan sinyal intent terbaru yang relevan dari data Agent Note. Tool seperti Copilot, CodeRabbit, Devin, dan Greptile dapat menggunakannya untuk memahami alasan perubahan sebelum membaca diff.

Ini tetap panduan, bukan bukti. Review tool harus membandingkannya dengan diff, test, dan code yang sebenarnya.

Langkah berikutnya

Jika Anda juga ingin tampilan Pages bersama untuk PR terbuka dan merged, lanjutkan ke Dashboard.