GitHub Action

Эта страница про PR Report, который появляется в GitHub Pull Requests. Если вам нужно только завершить локальный CLI setup, начните с Установки; вернитесь сюда, когда reviewers должны видеть summary Agent Note.

Быстрая настройка

Запустите это один раз в своём репозитории:

npx agent-note init --agent claude

Так создаётся workflow для отчёта в 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 }}

После этого каждая PR получает отчёт о сессии ИИ.

Inputs

Input	Значение по умолчанию	Описание
`base`	Базовая ветка PR	Ветка для сравнения
`pr_output`	`description`	Куда выводить отчёт PR: `description`, `comment` или `none`
`prompt_detail`	`compact`	Детализация истории prompts в отчёте PR: `compact` держит отчёт сфокусированным, `full` показывает все сохранённые prompts
`dashboard`	`false`	Запускает режим Dashboard вместо режима PR Report. Обычно генерируется через `agent-note init --dashboard`

Dashboard

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

Outputs

Output	Тип	Описание
`overall_ai_ratio`	number	Общий AI Ratio для PR (0-100)
`overall_method`	string	`line`, `file`, `mixed` или `none`
`tracked_commits`	number	Количество коммитов с данными agent-note
`total_commits`	number	Общее количество коммитов в PR
`total_prompts`	number	Общее число prompts во всех коммитах
`json`	string	Полный структурированный отчёт
`markdown`	string	Готовый Markdown-отчёт
`should_deploy`	boolean string	Output режима Dashboard, который сообщает вызывающему workflow, нужно ли публиковать Pages

Что входит в отчёт

Отчёт PR включает:

Header — Total AI Ratio с полосой и строкой Model ниже
Reviewer Context — скрытый Markdown-комментарий для AI Review tools, собранный из общих групп изменённых областей, фокуса review и последних релевантных сигналов намерения автора
Таблица — AI Ratio, число prompts и файлы по каждому коммиту
Prompts — записи 📝 Context, 🧑 Prompt и 🤖 Response по коммитам в раскрывающейся секции

AI Review tools

Reviewer Context сохраняется в PR body как скрытый Markdown-комментарий. Люди видят обычный отчёт, а инструменты, которые читают raw PR description, могут использовать дополнительный контекст.

Этот контекст строится детерминированно из данных Agent Note. Он суммирует изменённые области, фокус review и последние релевантные сигналы намерения автора. Copilot, CodeRabbit, Devin и Greptile могут использовать его, чтобы понять причину изменений до чтения diff.

Это подсказка, а не доказательство. Review tools должны сверять её с реальным diff, тестами и кодом.

Следующий шаг

Если вам нужна и общая Pages-витрина для открытых и смерженных PR, переходите к Dashboard.