Provider verification badges
See the the Badges section of the configuration page for information about accessing the badges.
If you are publishing Provider verification results to your Pact Broker (v2.3.0+), you can also display the verification status in your READMEs using a shiny badge like this one:
To get your badge, open the HTML version of your /latest, /latest/TAG or /latest-untagged pact in the Pact Broker by copy/pasting its URL into your browser location bar. Your badge will be shown in the top right of the page. When you click on it, a text box will appear with the markdown to include in your README.
The URL of the badge is the URL of the latest pact with /badge.svg appended, and it works for the /latest/TAG and /latest-untagged pact URLs as well
- Latest pact badge:
https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest/badge.svg - Latest tagged pact badge:
https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest/TAG/badge.svg - Latest un-tagged pact badge:
https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest-untagged/badge.svg)
The markdown to include in your README is as follows:
[](https://your-broker)For example:
[](https://test.pact.dius.com.au)Available in version v2.13.0+ of the Pact Broker gem.
If you are using tags for both the consumer and provider versions (this is recommended by the way!) the badge URL will be a little different. The format is:
/matrix/provider/PROVIDER/latest/PROVIDER_TAG/consumer/CONSUMER/latest/CONSUMER_TAG/badge
If your consumer and provider name make your badge too long to be aesthetically pleasing, you can shorten it in the following ways.
- Show just the consumer or provider name by adding
?label=consumeror?label=providerto the end of the URL.
- Use the pacticipant's initials by adding
?initials=true
- Use both the
labeland theinitialsparams to show only the initials of the consumer or provider.