From d92cf3bc43ce47d2131583d4400471e63867f197 Mon Sep 17 00:00:00 2001 From: Yousaf Nabi Date: Wed, 14 Aug 2024 13:44:25 +0100 Subject: [PATCH] docs: add state of current v3/v4 support with tracking issue links --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9967980..55be1b4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,26 @@ Provides shared code for the Pact gems -## Supported matching rules +## Compatibility + +
Specification Compatibility + +| Version | Stable | [Spec] Compatibility | +| ------- | ------ | -------------------- | +| 1.x.x | Yes | 2, 3\* | + +_\*_ v3 support is limited to the subset of functionality required to enable language inter-operable [Message support]. + +- See V3 tracking [issue](https://github.com/pact-foundation/pact-ruby/issues/318). +- See V4 tracking [issue](https://github.com/pact-foundation/pact-ruby/issues/319). + +Want V3/V4 support now? See the new standalone [pact-verifier](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_verifier_cli#standalone-pact-verifier) + +[message support]: https://github.com/pact-foundation/pact-specification/tree/version-3#introduces-messages-for-services-that-communicate-via-event-streams-and-message-queues + +
+ +### Supported matching rules | matcher | Spec Version | Implemented | Usage| |---------------|--------------|-------------|-------------| @@ -32,9 +51,11 @@ Provides shared code for the Pact gems | EachKey | V4 | | | | EachValue | V4 | | | -## Supported generators +### Supported generators + +Currently limited to provider verification only. No current way to set in consumer tests. -| matcher | Spec Version | Implemented | +| Generator | Spec Version | Implemented | |------------------------|--------------|----| | RandomInt | V3 | ✅ | | RandomDecimal | V3 | ✅ |