The releases API lets you declare deployment to Echoes. This information is then leveraged in multiple places:
- In the Releases page, to show the timeline of releases and their content.
- In Lead time, to compute the last segment of the development cycle.
- In Deployment frequency, to compute the frequency without relying on tags alone.
An API key is required in order to use the Signal Releases API.
In order to reduce client complexity, the create endpoint is idempotent. Retrying a release creation with the same payload and API key will result in a single release. For an identical release, the HTTP response code is 303 and the Location header set to the URL of the release, for instance: https://api.echoeshq.com/v1/signals/releases/b84930a6-9df0-4f42-bfbb-54d3b7ed590f (with b84930a6-9df0-4f42-bfbb-54d3b7ed590f being the ID of the release).
Version of the release.
List of the commits SHA shipped as part of the release. Each SHA can either be the commit's hash within the pull request which introduced it, or the hash resulting from a merge into the base branch (regardless of the merging strategy used).
Name of the release.
Commit SHA of the tag (for instance).
Simplified extended ISO format ISO 8601, which is always 24 or 27 characters long (YYYY-MM-DDTHH:mm:ss.sssZ or ±YYYYYY-MM-DDTHH:mm:ss.sssZ, respectively). The timezone is always zero UTC offset, as denoted by the suffix "Z". Defaults to the current time of reception of the event.
List of the deliverables the release contains (e.g., microservice name, application name).
Usage example in GitHub CI/CD
Content of the release.sh script
Patch a Release status by ID
ID of the release to change the status for.
The status of the Release either `failure` or `success`.
Updated 09 Mar 2023
Did this page help you?