Revues de pull requests GitHub

Faites relire des pull requests par un agent, soit via le canal de chat GitHub, soit depuis GitHub Actions qui appelle un webhook de routine quand une pull request est prête.

Veyra Docs TeamMis à jour le 2 min de lectureVersion 2 · Historique

Il existe deux façons d'amener des pull requests à un agent. Utilisez le canal GitHub quand des personnes doivent parler à l'agent sur GitHub. Utilisez un webhook de routine depuis GitHub Actions quand chaque pull request prête doit être relue, sans que personne ne le demande.

Option 1 : le canal GitHub

Connectez GitHub comme canal de chat. GitHub envoie alors les événements des dépôts choisis à :

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

Chaque livraison est vérifiée avec le secret de webhook de la GitHub App (X-Hub-Signature-256). Les mentions de l'agent et les demandes de revue deviennent des tâches ; l'agent répond dans la conversation de la pull request. L'identifiant X-GitHub-Delivery de GitHub empêche les relivraisons de créer des doublons.

Option 2 : un webhook de routine depuis GitHub Actions

Un workflow de votre dépôt appelle un déclencheur de routine quand une pull request passe ses vérifications. L'agent de la routine la relit et publie sa recommandation sur la tâche de la routine.

Configurer la routine

  1. Créez une routine avec votre agent relecteur. Dans sa demande, indiquez quoi vérifier et quoi publier, par exemple : « Relis la pull request {{pr_url}} au commit {{head_sha}}. Revérifie la tête et la base avant de commencer. Publie MERGE, HOLD ou DO NOT MERGE avec tes raisons. N'approuve pas, ne fusionne pas et ne commente pas sur GitHub. »
  2. Déclarez les variables texte obligatoires pr_url, pr_number, head_sha et base_sha.
  3. Réglez When a run overlaps sur Always enqueue, pour que des pull requests distinctes ne soient jamais fusionnées en une seule revue.
  4. Ajoutez un déclencheur webhook avec le mode de signature bearer. Copiez l'URL et le secret.

Configurer GitHub

  1. Dans le dépôt, créez un environnement Actions (par exemple pr-review) limité à votre branche par défaut.
  2. Ajoutez deux secrets d'environnement : VEYRA_REVIEW_WEBHOOK_URL et VEYRA_REVIEW_WEBHOOK_TOKEN.
  3. Ajoutez un workflow qui s'exécute depuis votre branche par défaut après vos vérifications et n'envoie que des identifiants, jamais de code :
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"

La clé d'idempotence rend sans effet un événement répété pour la même pull request, la même tête et la même base. Un nouveau commit ou une nouvelle base déclenche une nouvelle revue.

Tester

Créez d'abord le déclencheur en mode test. Une livraison en mode test est authentifiée et enregistrée sans lancer de revue ; désactivez le mode test quand elle passe.

Important

Le webhook transporte des identifiants, pas du code. L'agent doit les traiter comme non fiables, récupérer lui-même la pull request et confirmer que la tête et la base n'ont pas changé avant de recommander quoi que ce soit.

EntrantsGitHubRoutinesWebhooks