pact-foundation / pact-reference

Reference implementations for the pact specifications
https://pact.io
MIT License
91 stars 46 forks source link

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

Open mjpieters opened 1 month ago

mjpieters commented 1 month ago

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.