Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation for Pending Pacts #1134

Closed
pendsley opened this issue Jun 18, 2020 · 3 comments
Closed

Clarify documentation for Pending Pacts #1134

pendsley opened this issue Jun 18, 2020 · 3 comments

Comments

@pendsley
Copy link
Contributor

In the pact-jvm docs for Pending Pacts

You also need to provide the tags used to publish the providers main-line results (i.e. tags like prod or master).

https://github.com/DiUS/pact-jvm/tree/master/provider/junit5#pending-pact-support-version-410-and-later (And everywhere else Pending Pacts are mentioned)

This seems misleading the way it's worded, since you should set it to whatever the tag for the current branch is.

@uglyog
Copy link
Member

uglyog commented Jul 6, 2020

would this make more sense?

If your Pact broker supports pending pacts, you can enable support for that by enabling that on your Pact broker
annotation or with JVM system properties. You also need to provide the tags used to publish the providers main-line results
(you should set it to the current branch name). The broker will then label any pacts found that don't have a successful verification result as pending. That way, if they fail verification, the verifier will ignore those failures and not fail the build.

@pendsley
Copy link
Contributor Author

pendsley commented Jul 6, 2020

The part that confused me was having "...main-line results" in there, followed up with "...tags like prod or master". I think if that was rephrased, maybe we wouldn't need the followup/clarification?

If your Pact broker supports pending pacts, you can enable support for that by enabling that on your Pact broker annotation or with JVM system properties. You also need to provide the tags that will be published with your provider's verification results. The broker will then label any pacts found that don't have a successful verification result as pending. That way, if they fail verification, the verifier will ignore those failures and not fail the build.

That, followed by the code example might be enough?

@kflorence
Copy link
Contributor

@uglyog i think this one can be closed as it was addressed by d383ef7

@uglyog uglyog closed this as completed Aug 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants