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

Verifier CLI: README suggests only Pact V3 is supported, but in practice V1-V4 is supported. #423

Closed
mjpieters opened this issue May 17, 2024 · 1 comment
Labels
documentation Indicates a need for improvements or additions to documentation

Comments

@mjpieters
Copy link
Contributor

The Verifier CLI readme is confusing about what Pact specifications it supports. In practice, all versions are supported but the README suggests only V3 is covered.

The Verifier CLI README starts with:

It implements the V3 Pact specification.

but further down the page there is a section referencing V4:

Verifying V4 Pact files that require plugins

Given that the CLI is built using the rust_verifier library, which explicitly states it implements V3 and V4, the README is clearly out of date.

Moreover, the tool accepts older specification formats too, because the pact_models library converts these to V3 contracts anyway. So in practice, you can use it to verify contracts using any Pact schema version, from V1 through to V4.

Please update the README to reflect this.

@rholshausen rholshausen added the documentation Indicates a need for improvements or additions to documentation label Jul 9, 2024
@rholshausen
Copy link
Contributor

README has been updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants