How to register a deploy
How does Sleuth know when you have deployed? There are three different ways Sleuth can be notified:
Precise - send Sleuth a webhook so we know exactly when you've deployed
Approximate - automatically create deploys for every commit created
Approximate - automatically create deploys for every tag created
We highly recommend precise deploy registration. Knowing exactly when you've made your deploy unlocks the truly powerful features of Sleuth such as Impact tracking, notifications and more.
Ping Sleuth with a Git commit SHA or a tag tell Sleuth you've deployed by making a POST request. You'll need to provide theses values when making the call:
YOUR_API_KEYYOUR_SHAORG_NAMEPROJECT_NAME
You can find your API Key in Organization Settings > Details > Api key:
You can find YOUR_SHA using the commands:
git checkout YOUR_BRANCHgit rev-parse HEAD
Get more detailed information on precisely registering a deploy via the Sleuth API.
When this option is selected Sleuth treat every commit made to your branch as a deploy.
Sleuth allows you to specify a delay, in minutes. When this is set Sleuth will only create the deploy after the delay has elapsed. A delay of 0 will create the deploy immediately.
It's rarely the case that every commit is a deploy. Only true continuous deployment setups deploy every commit.
When this option is selected Sleuth will treat every tag made on your branch as a deploy.
Sleuth allows you to specify a delay, in minutes. When this is set Sleuth will only create the deploy after the delay has elapsed. A delay of 0 will create the deploy immediately.
A delay of 0 will create the deploy immediately.
If you've chosen this option make sure that your CD system is tagging your code only once it's actually been deployed.
