API-Referenz

Releases

Endpoint POST /api/v1/releases

Rufen Sie das aus Ihrer Deploy-Pipeline auf (oder verwenden Sie blipit releases new). Mit einem im Projekt gespeicherten GitHub-Token ruft Blipit die Commits selbst ab; andernfalls verwendet es die von Ihnen gesendeten Commits.

1Request

Geheimer Schlüssel in X-Blipit-Key. Body bis 2 MB: version (erforderlich, bis 256 Zeichen), commit und previous_commit (Git-SHAs, 7 bis 40 Hex), repo (owner/name), commits (optionale Liste aus git log: sha, message, author, geänderte Dateien, bis 250). Ohne previous_commit behält Blipit die Commits nach dem Commit des letzten Releases oder nur den Head bei einem ersten Release.

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"}'

2Antworten

200 {version, commits, source (github, cli oder null), previous_commit, warning?}. Die Warnung sagt, wenn die GitHub-Abfrage fehlgeschlagen ist und die CLI-Commits verwendet wurden. 400 bei ungültiger Version, SHA oder Repo. 401 unbekannter Schlüssel, 403 öffentlicher Schlüssel.

Gut zu wissen

  • repo darf nur owner/name sein; alles mit @, //, .., ?, # oder zusätzlichen Segmenten wird abgelehnt, damit GitHub-Aufrufe nur je api.github.com/repos/owner/name erreichen.
  • Der GitHub-Compare-Abruf hat ein Timeout von 10 Sekunden und liest geänderte Dateien für die neuesten 30 Commits.

Kommen Sie nicht weiter? Schreiben Sie an support@blipit.io. Schlüssel und den genauen DSN jedes Projekts finden Sie unter API-Schlüssel in app.blipit.io.