Ревью пул-реквестов GitHub

Поручайте агенту ревью пул-реквестов — через канал чата GitHub или из GitHub Actions, который вызывает вебхук рутины, когда пул-реквест готов.

Veyra Docs TeamОбновлено 1 мин чтенияВерсия 2 · История

Передать пул-реквесты агенту можно двумя способами. Канал GitHub подходит, когда люди должны общаться с агентом прямо в GitHub. Вебхук рутины из GitHub Actions — когда каждый готовый пул-реквест должен получать ревью без чьего-либо запроса.

Вариант 1: канал GitHub

Подключите GitHub как канал чата. Тогда GitHub будет отправлять события выбранных репозиториев на адрес:

HTTP
POST https://intelligence-api.veyra.so/api/chat-webhooks/{publicId}/github

Каждая доставка проверяется секретом вебхука GitHub App (X-Hub-Signature-256). Упоминания агента и запросы на ревью становятся задачами; агент отвечает в обсуждении пул-реквеста. Идентификатор X-GitHub-Delivery не даёт повторным доставкам создавать дубликаты.

Вариант 2: вебхук рутины из GitHub Actions

Workflow в вашем репозитории вызывает триггер рутины, когда пул-реквест проходит проверки. Агент рутины проводит ревью и публикует рекомендацию в задаче рутины.

Настройка рутины

  1. Создайте рутину с агентом-ревьюером. В запросе укажите, что проверять и что публиковать, например: «Проведи ревью пул-реквеста {{pr_url}} на коммите {{head_sha}}. Перед началом ещё раз проверь head и base. Опубликуй MERGE, HOLD или DO NOT MERGE с обоснованием. Не одобряй, не сливай и не комментируй в GitHub».
  2. Объявите обязательные текстовые переменные pr_url, pr_number, head_sha и base_sha.
  3. Установите для When a run overlaps значение Always enqueue, чтобы разные пул-реквесты никогда не объединялись в одно ревью.
  4. Добавьте триггер webhook с режимом подписи bearer. Скопируйте URL и секрет.

Настройка GitHub

  1. В репозитории создайте окружение Actions (например, pr-review), ограниченное основной веткой.
  2. Добавьте два секрета окружения: VEYRA_REVIEW_WEBHOOK_URL и VEYRA_REVIEW_WEBHOOK_TOKEN.
  3. Добавьте workflow, который запускается из основной ветки после ваших проверок и передаёт только идентификаторы, а не код:
YAML
name: Ask Veyra for a review
on:
  workflow_run:
    workflows: [ci]
    types: [completed]
permissions:
  contents: read
  pull-requests: read
jobs:
  notify:
    if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request'
    runs-on: ubuntu-latest
    environment: pr-review
    steps:
      - name: Send the pull request to the review routine
        env:
          URL: ${{ secrets.VEYRA_REVIEW_WEBHOOK_URL }}
          TOKEN: ${{ secrets.VEYRA_REVIEW_WEBHOOK_TOKEN }}
          PR: ${{ toJSON(github.event.workflow_run.pull_requests[0]) }}
        run: |
          number=$(jq -r .number <<<"$PR")
          head=$(jq -r .head.sha <<<"$PR")
          base=$(jq -r .base.sha <<<"$PR")
          body=$(jq -n --arg n "$number" --arg h "$head" --arg b "$base" \
            --arg u "https://github.com/${{ github.repository }}/pull/$number" \
            '{variables: {pr_url: $u, pr_number: $n, head_sha: $h, base_sha: $b}}')
          curl --fail --silent --show-error --max-time 15 --proto '=https' \
            -X POST "$URL" \
            -H "Authorization: Bearer $TOKEN" \
            -H "Content-Type: application/json" \
            -H "Idempotency-Key: pr-$number-$head-$base" \
            --data "$body"

Благодаря ключу идемпотентности повторное событие для того же пул-реквеста с теми же head и base ничего не делает. Новый коммит или новая base получают новое ревью.

Проверка

Сначала создайте триггер в тестовом режиме. Доставка в тестовом режиме проходит аутентификацию и записывается, но ревью не запускает; когда всё работает, выключите тестовый режим.

Важно

Вебхук передаёт идентификаторы, а не код. Агент должен считать их недоверенными, сам получить пул-реквест и убедиться, что head и base не изменились, прежде чем что-либо рекомендовать.

GitHubВебхукиВходящиеРутины