Skip to content

Commit

Permalink
chore: add can-i-merge badge docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mefellows
mefellows committed Aug 12, 2024
1 parent e175494 commit 2b2b12c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
38 changes: 28 additions & 10 deletions website/docs/pact_broker/advanced_topics/provider_verification_badges.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ _See the the_ [_Badges_](/pact_broker/configuration/features#badges) _section of

If you are publishing [Provider verification results](provider_verification_results.md) to your Pact Broker \(v2.3.0+\), you can also display the verification status in your READMEs using a shiny badge like this one:

[![Pact Status](https://test.pactflow.io/pacticipants/FrontendWebsite/branches/test/latest-version/can-i-deploy/to-environment/test/badge)](https://test.pactflow.io/pacticipants/FrontendWebsite/branches/test/latest-version/can-i-deploy/to-environment/test)
[![Pact Status](https://test.pactflow.io/pacticipants/pactflow-example-consumer/branches/master/latest-version/can-i-deploy/to-environment/prod/badge)](https://test.pactflow.io/pacticipants/pactflow-example-consumer/branches/master/latest-version/can-i-deploy/to-environment/production)

For mergability checks for branches, use the can-i-merge badge. For deployability checks for environments, use the can-i-deploy badge.

## Can I Deploy badge

Expand All @@ -18,7 +20,7 @@ Requires version 2.94+ of the Pact Broker

Returns a status badge that can be displayed in a README file that indicates whether the latest version of a pacticipant from a particular branch can be deployed to the specified environment.

[![Can I Deploy BRANCH to ENVIRONMENT](https://test.pactflow.io/pacticipants/FrontendWebsite/branches/test/latest-version/can-i-deploy/to-environment/test/badge)](https://test.pactflow.io/pacticipants/FrontendWebsite/branches/test/latest-version/can-i-deploy/to-environment/test)
[![Can I Deploy BRANCH to ENVIRONMENT](https://test.pactflow.io/pacticipants/pactflow-example-consumer/branches/master/latest-version/can-i-deploy/to-environment/prod/badge)](https://test.pactflow.io/pacticipants/pactflow-example-consumer/branches/master/latest-version/can-i-deploy/to-environment/production)

```text
[![Can I Deploy BRANCH to ENVIRONMENT](https://your-broker/pacticipants/PACTICIPANT/branches/BRANCH/latest-version/can-i-deploy/to-environment/ENVIRONMENT/badge)](https://your-broker/hal-browser/browser.html#https://your-broker/pacticipants/PACTICIPANT/branches/BRANCH/latest-version/can-i-deploy/to-environment/ENVIRONMENT)
Expand All @@ -32,13 +34,29 @@ Requires version 2.62+ of the Pact Broker.

Returns a status badge that can be displayed in a README file that indicates whether the latest version of a pacticipant with a specified tag can be deployed to the specified environment as identified by a tag.

[![Can I deploy Foo status](https://test.pactflow.io/pacticipants/FrontendWebsite/latest-version/test/can-i-deploy/to/test/badge)](https://test.pactflow.io/pacticipants/FrontendWebsite/latest-version/test/can-i-deploy/to/test)
[![Can I deploy Foo status](https://test.pactflow.io/pacticipants/pactflow-example-consumer/latest-version/prod/can-i-deploy/to/production/badge)](https://test.pactflow.io/pacticipants/pactflow-example-consumer/latest-version/prod/can-i-deploy/to/production)

```text
[![Can I deploy Foo status](https://your-broker/pacticipants/PACTICIPANT/latest-version/TAG/can-i-deploy/to/ENVIRIONMENT_TAG/badge)](https://your-broker/pacticipants/PACTICIPANT/latest-version/TAG/can-i-deploy/to/ENVIRIONMENT_TAG)
```

[![Can I deploy Foo status](https://test.pactflow.io/pacticipants/FrontendWebsite/latest-version/test/can-i-deploy/to/test/badge?label=my+custom+label+here)](https://test.pactflow.io/pacticipants/FrontendWebsite/latest-version/test/can-i-deploy/to/test)
[![Can I deploy Foo status](https://test.pactflow.io/pacticipants/pactflow-example-consumer/latest-version/prod/can-i-deploy/to/production/badge?label=my+custom+label+here)](https://test.pactflow.io/pacticipants/pactflow-example-consumer/latest-version/prod/can-i-deploy/to/production)

To set a custom label for the badge, set the `label` query parameter. eg `?label=my+custom+label+here`.

## Can I Merge badge

[![Can I Merge Status](/img/can-i-merge-badge.svg)](https://test.pactflow.io)

Requires version 2.111.0+ of the Pact Broker

Returns a status badge that can be displayed in a README file that indicates whether the latest version associated with main branch of the specified pacticipant is compatible with the configured main branch of each of the pacticipants with which it is integrated.

[![Can I Merge](https://test.pactflow.io/pacticipants/pactflow-example-consumer/main-branch/can-i-merge/badge)](https://test.pactflow.io/pacticipants/pactflow-example-consumer/main-branch/can-i-merge/badge)

```text
[![Can I Merge](https://test.pactflow.io/pacticipants/pactflow-example-consumer/main-branch/can-i-merge/badge)](https://your-broker/hal-browser/browser.html#https://your-broker/pacticipants/PACTICIPANT/main-branch/can-i-merge/badge)
```

To set a custom label for the badge, set the `label` query parameter. eg `?label=my+custom+label+here`.

Expand All @@ -60,7 +78,7 @@ The URL of the badge is the URL of the latest pact with `/badge.svg` appended, a

The markdown to include in your README is as follows:

[![Foo/Bar Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Foo/Bar Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)

```text
[![Foo/Bar Pact Status](https://your-broker/pacts/provider/PROVIDER/consumer/CONSUMER/latest/badge.svg)](https://your-broker)
Expand All @@ -69,7 +87,7 @@ The markdown to include in your README is as follows:
For example:

```text
[![Foo/Bar Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Foo/Bar Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)
```

#### With consumer and provider tags
Expand All @@ -82,19 +100,19 @@ If you are using tags for both the consumer and provider versions \(this is reco

### Options

[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)

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=consumer` or `?label=provider` to the end of the URL.

[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg?label=consumer)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg?label=consumer)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)

* Use the pacticipant's initials by adding `?initials=true`

[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg?initials=true)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg?initials=true)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)

* Use both the `label` and the `initials` params to show only the initials of the consumer or provider.

[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest/badge.svg?initials=true&label=consumer)](https://test.pactflow.io/pacts/provider/ProductService/consumer/FrontendWebsite/latest)
[![Pact Status](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest/badge.svg?initials=true&label=consumer)](https://test.pactflow.io/pacts/provider/ProductService/consumer/pactflow-example-consumer/latest)

1 change: 1 addition & 0 deletions website/static/img/can-i-merge-badge.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2b2b12c

Please sign in to comment.