Sleuth detects the changes that happen between deploys by analyzing commits to your Git repository.
Creating a Project
To create a project click the '+' button and choose 'create project'. You will be able to link your Bitbucket or GitHub account from this screen if you haven't already done so.
To track deploys we must have access to the code you deploy. In order to access all of your commit, issue and pull request information we need to authorize with a full read and write scope.
To create a new project just select the code repository from the dropdown and specify the branch that you deploy from. Sleuth will initialize the project with your last commit until we start detecting further deploys.
Telling us when you deploy
You have three ways you can alert Sleuth of a deploy.
- Manually register your deploy by making a POST request to Sleuth each time you deploy
- Automatic tracking for each push to the configured branch. Just push to your branch and watch the deploys roll in.
- Automatic tracking for each tag made against the configured branch. Just push up a new tag and Sleuth will do the rest.
Manually registering your deploy
Ping us with a Git commit sha or tag to mark your deploy by making a POST to DeployHub.
curl -X POST -d api_key=YOUR_API_KEY -d sha=YOUR_SHA https://sleuth.io/api/1/ORG_NAME/PROJECT_NAME/register_deploy
Make sure to replace
PROJECT_NAME with your actual information.
You can find
YOUR_SHA with the commands:
git checkout YOUR_BRANCH git rev-parse HEAD
Automatic tracking for each push to the configured branch
This will ping Sleuth every time a commit is made. When we detect a commit against your projects branch we'll register a new deploy.
Automatic tracking for each tag made against the configured branch
This will ping Sleuth every time a commit is made. When we detect a tag against your projects branch we'll register a new deploy.
How to tag your code
A tag name can be anything but we suggest something like:
To tag your code and push your changes to your remote repository, use a similar command to:
git tag production_2015-04-18--16-15 git push [email protected]:joeuser/myrepo.git production_2015-04-18--16-15