With Squadlytics you can track deployment events to understand how often you release code to your customers and keep track of environments that have not been updated in a while.
The Squadlytics CLI is a tool that can help you send deployment events from your continuous delivery tools, or your deployment scripts.
Please note that if you are using Heroku you can use our Heroku integration to send deployment events to your projects.
You will need Node v4+ to be able to use the CLI.
To install the Squadlytics CLI simply run the command below.
npm install -g squadlytics-cli
The following information is required to be able to send a deployment event:
With that information you can send a deployment event from your script with the following:
squadlytics rec-deployment -a <application_name> -i <deployment_ID> <notification_URL>
If you want to send a deployment failure just use the -f flag.
squadlytics rec-deployment -f -a <application_name> -i <deployment_ID> <notification_URL>
The bitbucket-pipelines.yml configuration below uses the Squadlytics CLI to send deployment events whenever code is deployed to the staging and prod environments of the acme-ui app.
In this scenario we're using -staging and -prod suffixes to indicate which environment has been deployed and we have configured the following environment variable in Bitbucket Pipelines:
The other environment variable $BITBUCKET_BUILD_NUMBER is a default variable available for all pipelines.
image: node:4 pipelines: branches: master: - step: name: Build and test script: - npm install - npm run build artifacts: - build/** - step: name: Deploy to staging script: - ./deploy-staging.sh - npm install -g squadlytics-cli - squadlytics rec-deployment -a acme-ui-staging -i $BITBUCKET_BUILD_NUMBER $NOTIFICATION_URL - step: name: Deploy to production script: - ./deploy-prod.sh - npm install -g squadlytics-cli - squadlytics rec-deployment -a acme-ui-prod -i $BITBUCKET_BUILD_NUMBER $NOTIFICATION_URL default: - step: script: # Modify the commands below to build your repository. - npm install - npm test