Tracking Deployments

Track deployments to understand how changes impact performance. Deploys allow you to see timeline markers for code deployments.

Step 1: Obtain your Site details

To create a deploy you will need your site-slug and either your site-secret or an API Token with permissions to create deploys.

Your site-slug and site-secret can be found on the Site → Settings → General page. You can access or create an API Token at admin level (Manage → API) or a Personal Access Token in the Profile drodpown (upper right-hand-side corner of the main navigation).

Step 2: Create a deploy

You can create deploys with the CLI, Node.js API or by using the HTTP Site API.

1calibre site create-deploy --site=<site-slug>

1const { Deploy } = require('calibre')
2
3await Deploy.create({
4  site: '<site-slug>',
5})

1curl --request POST\
2https://calibreapp.com/api/sites/<site-slug>/deploys?secret=<site-secret>

Step 3: View your deploy

Your deploy will now be viewable on all metric charts within Calibre: