Referência da API

Releases

Endpoint POST /api/v1/releases

Chame isto do seu pipeline de deploy (ou use blipit releases new). Com um token do GitHub salvo no projeto, o Blipit busca os commits por conta própria; caso contrário, usa os commits que você envia.

1Requisição

Chave secreta em X-Blipit-Key. Corpo de até 2 MB: version (obrigatório, até 256 caracteres), commit e previous_commit (shas do git, 7 a 40 hexadecimais), repo (owner/name), commits (lista opcional do git log: sha, mensagem, autor, arquivos alterados, até 250). Sem previous_commit, o Blipit mantém os commits posteriores ao commit da última release, ou apenas o head em uma primeira 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"}'

2Respostas

200 {version, commits, source (github, cli ou null), previous_commit, warning?}. O warning informa quando a consulta ao GitHub falhou e os commits da CLI foram usados. 400 para version, sha ou repo inválidos. 401 chave desconhecida, 403 chave pública.

Bom saber

  • repo só pode ser owner/name; qualquer coisa com @, //, .., ?, # ou segmentos extras é recusada para que as chamadas ao GitHub só alcancem api.github.com/repos/owner/name.
  • A busca compare do GitHub tem timeout de 10 segundos e lê os arquivos alterados dos 30 commits mais recentes.

Travou? Envie um e-mail para support@blipit.io. As chaves e o DSN exato de cada projeto ficam em Chaves de API no app.blipit.io.