GitHub pull request incelemeleri
Pull request'leri bir agent'a inceletin: ya GitHub sohbet kanalı üzerinden ya da bir pull request hazır olduğunda GitHub Actions'ın bir rutin webhook'unu çağırmasıyla.
Pull request'leri bir agent'a getirmenin iki yolu var. Kişilerin agent'la GitHub'da konuşması gerekiyorsa GitHub kanalını kullanın. Kimse istemeden hazır olan her pull request'in incelenmesini istiyorsanız GitHub Actions'tan bir rutin webhook'u kullanın.
Seçenek 1: GitHub kanalı
GitHub'ı bir sohbet kanalı olarak bağlayın. GitHub, seçtiğiniz depoların olaylarını şu adrese gönderir:
POST https://intelligence-api.veyra.so/api/chat-webhooks/{publicId}/githubHer teslimat GitHub App'in webhook sırrıyla (X-Hub-Signature-256) doğrulanır. Agent'tan bahsedilmeleri ve inceleme istekleri görev olur; agent pull request'in yazışmasında yanıt verir. GitHub'ın X-GitHub-Delivery kimliği, yeniden teslimatların kopya oluşturmasını önler.
Seçenek 2: GitHub Actions'tan bir rutin webhook'u
Deponuzdaki bir iş akışı, bir pull request kontrollerinden geçtiğinde bir rutin tetikleyicisini çağırır. Rutinin agent'ı onu inceler ve önerisini rutinin görevine yazar.
Rutini kurun
- İnceleyici agent'ınızla bir rutin oluşturun. İsteğinde neyin kontrol edileceğini ve neyin yayımlanacağını yazın, örneğin: "{{pr_url}} pull request'ini {{head_sha}} başında incele. Başlamadan önce head ve base'i yeniden doğrula. Gerekçelerinle birlikte MERGE, HOLD ya da DO NOT MERGE yaz. GitHub'da onaylama, birleştirme ya da yorum yapma."
- Zorunlu metin değişkenleri olarak
pr_url,pr_number,head_shavebase_sha'yı tanımlayın. - Farklı pull request'ler asla tek bir incelemede birleşmesin diye When a run overlaps ayarını Always enqueue yapın.
- İmzalama modu
bearerolan bir webhook tetikleyicisi ekleyin. URL'yi ve sırrı kopyalayın.
GitHub'ı kurun
- Depoda, varsayılan dalınızla sınırlı bir Actions ortamı oluşturun (örneğin
pr-review). - İki ortam sırrı ekleyin:
VEYRA_REVIEW_WEBHOOK_URLveVEYRA_REVIEW_WEBHOOK_TOKEN. - Kontrolleriniz bittikten sonra varsayılan daldan çalışan ve asla kod değil yalnızca tanımlayıcılar gönderen bir iş akışı ekleyin:
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"Idempotency anahtarı, aynı pull request, head ve base için tekrarlanan bir olayı etkisiz kılar. Yeni bir commit ya da yeni bir base yeni bir inceleme alır.
Test edin
Tetikleyiciyi önce test modunda oluşturun. Test modundaki bir teslimat, inceleme başlatmadan doğrulanır ve kaydedilir; geçtiğinde test modunu kapatın.
Önemli
Webhook kod değil, tanımlayıcılar taşır. Agent bunlara güvenilmez veri olarak davranmalı, pull request'i kendisi almalı ve bir şey önermeden önce head ile base'in değişmediğini doğrulamalıdır.