Skip to content

Provider verification badges

Beth Skurrie edited this page Jul 14, 2017 · 18 revisions

Note that badges are disabled by default for security reasons. See the Badges section of the Configuration page for more information.

If you are publishing Provider verification results to your Pact Broker, you can also display the verification status in your READMEs using a badge.

Pact Status

The markdown to include in your README is as follows:

[![Foo/Bar Pact Status](https://your-broker/pacts/provider/Bar/consumer/Foo/latest/badge.svg)](https://your-broker)

For example:

[![Foo/Bar Pact Status](https://test.pact.dius.com.au/pacts/provider/Bar/consumer/Foo/latest/badge.svg)](https://test.pact.dius.com.au)

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 (eg. https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest/TAG/badge.svg and https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest-untagged/badge.svg)