API referansı

Release'ler

Endpoint POST /api/v1/releases

Bunu deploy pipeline'ınızdan çağırın (ya da blipit releases new kullanın). Projede kayıtlı bir GitHub token'ı ile Blipit commit'leri kendisi alır; aksi halde gönderdiğiniz commit'leri kullanır.

1İstek

Secret key X-Blipit-Key içinde. Gövde en fazla 2 MB: version (zorunlu, en fazla 256 karakter), commit ve previous_commit (git sha'ları, 7 ile 40 hex), repo (owner/name), commits (git log'dan isteğe bağlı liste: sha, mesaj, yazar, değişen dosyalar, en fazla 250). previous_commit olmadan Blipit son release'in commit'inden sonraki commit'leri, ilk release için ise yalnızca head'i tutar.

sh
curl https://in.blipit.io/api/v1/releases \
  -H "Content-Type: application/json" -H "X-Blipit-Key: <secret key>" \
  -d '{"version":"shop@1.4.2","commit":"9fceb02a","previous_commit":"3a1c7f0d","repo":"acme/shop"}'

2Yanıtlar

200 {version, commits, source (github, cli ya da null), previous_commit, warning?}. warning, GitHub sorgusunun başarısız olduğunu ve CLI commit'lerinin kullanıldığını belirtir. 400 hatalı version, sha ya da repo için. 401 bilinmeyen anahtar, 403 public key.

Bilmekte fayda var

  • repo yalnızca owner/name olabilir; @, //, .., ?, # ya da ek segment içeren her şey reddedilir; böylece GitHub çağrıları yalnızca api.github.com/repos/owner/name adresine ulaşır.
  • GitHub compare alımının 10 saniyelik zaman aşımı vardır ve en yeni 30 commit için değişen dosyaları okur.

Takıldınız mı? support@blipit.io adresine e-posta gönderin. Her projenin anahtarları ve tam DSN'i app.blipit.io içindeki API anahtarları altındadır.