- Ana sayfa
- Dokümantasyon
- CI'da yayın kapısı
CI'da yayın kapısı
AI CodeOps yayın kapısını GitHub Actions, GitLab CI, Bitbucket Pipelines, Forgejo veya Gitea'dan çağırın, ret durumunda işi başarısız kılın ve zorunlu bir kontrol yapın.
Yayın kapısı pipeline'ınız için tek bir soruyu yanıtlar: bu pull request yayına alınabilir mi? CI'ınız pull request URL'sini bir çalışma alanı API anahtarıyla POST /api/release/check adresine gönderir. AI CodeOps değişikliğe dokunan her oturuma bakar ve gerekçeleriyle birlikte allowed: true veya allowed: false yanıtını verir; gerekçeler başarısız testler, açık bir yüksek (high) veya kritik (critical) bulgu, tamamlanmamış bir inceleme ya da geçmeyen bir repo build'i olabilir. Ayrıca, projede Don't run tests for this project seçeneği açık olmadıkça, kodu değiştiren ve sayıları içeren bir test sonucu olmayan bir oturumu da reddeder. Bunlar konsoldaki kalite kapılarıyla aynı kurallardır.
AI CodeOps pull request'lerini codeops/run-<id> adlı branch'lerden açar. Kapı, hiçbir AI CodeOps oturumunun dokunmadığı bir değişikliği reddeder; bu yüzden aşağıdaki işler yalnızca bu branch'leri sorar. Diğer kontrolleriniz yine her pull request'te çalışır.
Bir API anahtarı oluşturun
- Konsolda Configure → API Keys sayfasını açın ve bir anahtar oluşturun. Secret
sk-ile başlar ve yalnızca bir kez gösterilir. - Onu CI sisteminizin secret deposunda
AICODEOPS_API_KEYadıyla saklayın. Repoya koymayın.
| CI sistemi | Secret'ın konulacağı yer |
|---|---|
| GitHub Actions | Reponun Settings → Secrets and variables → Actions sayfası, repository secret olarak |
| GitLab CI | Settings → CI/CD → Variables, masked olarak |
| Bitbucket Pipelines | Repository settings → Repository variables, Secured işaretli olarak |
| Forgejo ve Gitea Actions | Reponun Settings → Actions → Secrets sayfası |
GitLab'de, codeops/* branch'leriniz korumalı değilse Protect variable seçeneğini kapalı bırakın. Korumalı bir değişken yalnızca korumalı branch'lerdeki pipeline'lara verilir; dolayısıyla iş boş bir anahtar alır.
Anahtar, onu oluşturan üye olarak hareket eder ve workspace:read iznine ihtiyaç duyar. Planınız anahtar kapsamı sınırlamayı içeriyorsa bir Admin, anahtarı yayın kapısı kontrolüyle sınırlayabilir. Anahtarlar hakkında daha fazlası Çalışma alanı API anahtarları bölümündedir.
Aşağıdaki işler https://console.aicodeops.dev adresini çağırır. Konsolu açtığınız adresi kullanın. Konsolda Review & Gate altındaki Release gate sayfası, GitHub Actions ve GitLab CI işlerini adresiniz doldurulmuş hâlde ve bir Copy düğmesiyle gösterir.
İşi ekleyin
Her iş pull request URL'sini gönderir, özeti ve gerekçeleri yazdırır ve yanıt allowed: true değilse başarısız olur. Uç nokta ret için de 200 yanıtı verir; bu yüzden iş durum kodunu değil, alanı okur. curl --fail seçeneği hatalı bir anahtarı, bir istek limitini veya bir kesintiyi başarısız bir işe dönüştürür.
GitHub Actions
Bunu .github/workflows/aicodeops-release-gate.yml olarak kaydedin:
name: AI CodeOps release gate
on:
pull_request:
permissions:
contents: read
jobs:
release-gate:
name: AI CodeOps release gate
# AI CodeOps opens its pull requests from codeops/run-<id> branches.
if: startsWith(github.head_ref, 'codeops/run-')
runs-on: ubuntu-latest
steps:
- name: Ask the release gate
env:
AICODEOPS_API_KEY: ${{ secrets.AICODEOPS_API_KEY }}
AICODEOPS_URL: https://console.aicodeops.dev
PR_URL: ${{ github.event.pull_request.html_url }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: |
body=$(jq -n --arg pr "$PR_URL" --arg sha "$HEAD_SHA" '{pullRequestURL: $pr, commitSHA: $sha}')
response=$(curl -sS --fail --retry 3 --max-time 30 -X POST "$AICODEOPS_URL/api/release/check" \
-H "Authorization: Bearer $AICODEOPS_API_KEY" \
-H "Content-Type: application/json" \
-d "$body") || { echo "::error::Release check unavailable: failing closed"; exit 1; }
echo "$response" | jq -r '.summary, ((.reasons // [])[] | "- " + .)'
if [ "$(echo "$response" | jq -r '.allowed')" != "true" ]; then
echo "::error::AI CodeOps release gate denied this change"
exit 1
fi
Pull request URL'sini ve head commit'ini gönderir. Bir oturum ikisinden biriyle eşleşir.
GitLab CI
Bu işi .gitlab-ci.yml dosyasına ekleyin:
aicodeops-release-gate:
image: alpine:3.20
rules:
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
variables:
AICODEOPS_URL: https://console.aicodeops.dev
before_script:
- apk add --no-cache curl jq
script:
- |
case "$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME" in
codeops/run-*) ;;
*) echo "Not an AI CodeOps branch: nothing to check."; exit 0 ;;
esac
body=$(jq -n --arg pr "$CI_MERGE_REQUEST_PROJECT_URL/-/merge_requests/$CI_MERGE_REQUEST_IID" '{pullRequestURL: $pr}')
response=$(curl -sS --fail --retry 3 --max-time 30 -X POST "$AICODEOPS_URL/api/release/check" \
-H "Authorization: Bearer $AICODEOPS_API_KEY" \
-H "Content-Type: application/json" \
-d "$body") || { echo "Release check unavailable: failing closed"; exit 1; }
echo "$response" | jq -r '.summary, ((.reasons // [])[] | "- " + .)'
if [ "$(echo "$response" | jq -r '.allowed')" != "true" ]; then
echo "AI CodeOps release gate denied this change"
exit 1
fi
İş, merge request pipeline'larında çalışır. AI CodeOps'un açmadığı bir branch'te sormadan geçer; böylece pipeline yine bir sonuç bildirir.
Bitbucket Pipelines
Bunu bitbucket-pipelines.yml dosyasına ekleyin. codeops/** deseni, adımı AI CodeOps branch'lerinden gelen pull request'lerle sınırlar:
pipelines:
pull-requests:
"codeops/**":
- step:
name: AI CodeOps release gate
image: alpine:3.20
script:
- apk add --no-cache curl jq
- |
AICODEOPS_URL="https://console.aicodeops.dev"
body=$(jq -n --arg pr "https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID" '{pullRequestURL: $pr}')
response=$(curl -sS --fail --retry 3 --max-time 30 -X POST "$AICODEOPS_URL/api/release/check" \
-H "Authorization: Bearer $AICODEOPS_API_KEY" \
-H "Content-Type: application/json" \
-d "$body") || { echo "Release check unavailable: failing closed"; exit 1; }
echo "$response" | jq -r '.summary, ((.reasons // [])[] | "- " + .)'
if [ "$(echo "$response" | jq -r '.allowed')" != "true" ]; then
echo "AI CodeOps release gate denied this change"
exit 1
fi
Forgejo ve Gitea Actions
Bunu Forgejo'da .forgejo/workflows/aicodeops-release-gate.yml, Gitea'da ise .gitea/workflows/aicodeops-release-gate.yml olarak kaydedin. runs-on alanını runner'larınızdan birinin sahip olduğu bir etikete ayarlayın:
name: AI CodeOps release gate
on:
pull_request:
jobs:
release-gate:
runs-on: docker
steps:
- name: Ask the release gate
env:
AICODEOPS_API_KEY: ${{ secrets.AICODEOPS_API_KEY }}
AICODEOPS_URL: https://console.aicodeops.dev
PR_URL: ${{ github.server_url }}/${{ github.repository }}/pulls/${{ github.event.number }}
BRANCH: ${{ github.head_ref }}
run: |
set -eu
case "$BRANCH" in
codeops/run-*) ;;
*) echo "Not an AI CodeOps branch: nothing to check."; exit 0 ;;
esac
response=$(curl -sS --fail --retry 3 --max-time 30 -X POST "$AICODEOPS_URL/api/release/check" \
-H "Authorization: Bearer $AICODEOPS_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"pullRequestURL\":\"$PR_URL\"}") || { echo "Release check unavailable: failing closed"; exit 1; }
echo "$response"
printf '%s' "$response" | grep -Eq '"allowed"[[:space:]]*:[[:space:]]*true' || { echo "AI CodeOps release gate denied this change"; exit 1; }
Bu iş, grep aracını jq yerine kullanır; dolayısıyla runner'ın yalnızca curl aracına ihtiyacı vardır. Desen iki nokta üst üste işaretinin çevresinde boşluklara izin verir; böylece yanıt nasıl biçimlendirilmiş olursa olsun aynı şekilde okunur. Gerekçeler dahil yanıtın tamamını yazdırır.
İş, geçmesi gereken bir değişiklikte başarısız olursa
- "No workflow runs found for …": işin gönderdiği URL, AI CodeOps'un pull request'i açarken kaydettiği URL değildir. İş günlüğündeki URL'yi konsolda değişikliğin üzerindeki pull request bağlantısıyla karşılaştırın. Sondaki eğik çizgi yok sayılır.
- İş, özet yazdırmadan önce başarısız oluyor: anahtar eksik veya yanlıştır ya da çalışma alanı bir dakikada 60'tan fazla kontrol yapmıştır. Secret'ın adını ve anahtarın silinmediğini kontrol edin.
Zorunlu bir kontrol yapın
Başarısız bir iş tek başına bir merge işlemini durdurmaz. Onu Git platformunuzda zorunlu kılın:
- GitHub. Varsayılan branch'iniz için branch korumasında veya bir ruleset'te Require status checks to pass before merging seçeneğini açın ve AI CodeOps release gate kontrolünü ekleyin. Bir kontrol, bir kez çalıştıktan sonra listede görünür. Diğer branch'lerden gelen pull request'lerde iş atlanır ve GitHub atlanan bir işi geçmiş sayar.
- GitLab. Settings → Merge requests → Merge checks altında Pipelines must succeed seçeneğini açın. Skipped pipelines are considered successful seçeneğini kapalı bırakın.
- Bitbucket. Repository settings → Branch restrictions altında, başarısız build olmadan asgari sayıda başarılı build için merge check ekleyin. Çözülmemiş merge check'lerde merge işlemini engellemek Premium planı gerektirir. Standard planında kontrol uyarır ve insanlar yine de merge edebilir.
- Forgejo ve Gitea. Varsayılan branch'inizin branch koruma kuralında Enable status check seçeneğini açın ve işi Status check patterns alanına ekleyin. Adının görünmesi için önce işi bir kez çalıştırın.
Ardından codeops/* branch'lerine kimin push edebileceğini kısıtlayın ya da bir branch değiştiğinde onayların sıfırlanmasını sağlayın. Kapı, birinin sonradan branch'e eklediği bir commit hakkında değil, oturumun değişikliği hakkında yanıt verir.
Bilinmeye değer seçenekler
Daha fazlasını istemek için JSON gövdesine alanlar ekleyin. Yukarıdaki işlerde bu, jq -n satırıdır:
body=$(jq -n --arg pr "$PR_URL" '{pullRequestURL: $pr, blockingSeverity: "medium", minCoveragePct: 80}')
| Seçenek | Varsayılan | Ne yapar |
|---|---|---|
blockingSeverity | high | Reddeden açık bulgunun en düşük önem derecesi: critical, high, medium, low veya info |
minCoveragePct | ayarlanmamış | 0 ile 100 arasında bir kapsam alt sınırı. Kapsam bildiren en son test çalıştırması bunu karşılamalıdır |
blockOnInFlight | false | Değişiklik için bir oturum veya repo build'i hâlâ çalışırken reddeder |
blockOnBuildFailure | true | Commit'in veya pull request'in başarısız olan, zaman aşımına uğrayan veya iptal edilen bir repo build'i reddeder. Build'leri dışarıda bırakmak için false olarak ayarlayın |
Kapsam alt sınırı hata durumunda kapalı kalır. minCoveragePct alanını ayarlarsanız ve değişiklik üzerindeki hiçbir test çalıştırması kapsam bildirmediyse kapı reddeder: "Coverage wasn't reported, so the 80% floor can't be checked". Kontrol edemediği bir alt sınır geçmez. Bu alanı, projenizin test komutu bir kapsam özeti yazdırdığında (örneğin pytest --cov veya vitest run --coverage) ve oturumun çalıştırma sayfası bir kapsam değeri gösterdiğinde ayarlayın.
Çalışan bir oturumu bekleme. blockOnInFlight olmadan, bir oturumu bitmiş bir değişiklik, bir başkası hâlâ çalışırken geçebilir. Bu seçenekle kapı, değişikliğe ait her oturum ve build bitene kadar reddeder. Beklemesi gereken bir iş, bir gerekçe bir şeyin hâlâ çalıştığını söylediği sürece çağrıyı aralıklarla yineleyebilir ve kendi süre sınırından sonra vazgeçebilir. Çalışma alanı için dakikada 60 kontrolün altında kalın.
Zorunlu iş akışları, izin verilmeyen lisanslar, zorunlu bir önceki dağıtım ve diğer alanlar API sayfasındadır; her yanıt alanı ise yayın kontrolü referansında yer alır.
Sonraki adımlar
Sık sorulan sorular
İşler neden yalnızca codeops/ branch'lerini soruyor?
Kapı, AI CodeOps oturumlarını değerlendirir ve hiç oturumu olmayan bir değişikliği reddeder. Bir insanın elle açtığı pull request'in arkasında oturum yoktur; dolayısıyla onu sormak her zaman başarısız olur.
Reddedilen bir değişiklik hata durum koduyla mı döner?
Hayır. Uç nokta hem izin hem de ret için 200 yanıtı verir. İş, allowed alanını okur ve alan true değilse başarısız olur.
Kapıya ulaşılamazsa ne olur?
İş başarısız olur. Bu sayfadaki her iş bir ağ hatasını, hatalı bir anahtarı veya istek limitini başarısızlık sayar; böylece çalışmamış bir kontrol asla bir değişikliği geçirmez.