Skip to content

Commit 041a091

Browse files
authored
Merge pull request #124 from pact-foundation/docs/pact_spec_compat
docs: add pact spec compat notes and warning
2 parents 4ae7ae1 + bcd1e5b commit 041a091

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ This setup simplifies Pact Provider [verification](https://docs.pact.io/document
44
process in any language, wrapping the Ruby implementation into a cross-platform,
55
binary-like CLI tool.
66

7-
[![Build Status](https://travis-ci.org/pact-foundation/pact-provider-verifier.svg?branch=master)](https://travis-ci.org/pact-foundation/pact-provider-verifier)
7+
[![Test](https://github.com/pact-foundation/pact-provider-verifier/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/pact-foundation/pact-provider-verifier/actions/workflows/test.yml)
88

99
**Features**:
1010

1111
* Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/pact-foundation/pact_broker)
1212
* Verify local `*.json` Pacts on the file system
1313
* Works with Pact [provider states](https://docs.pact.io/getting_started/provider_states) should you need them
1414
* Publishes the verification results back to the pact broker if the pact was retrieved from a broker.
15+
* ⚠️ - For Pact Specification V3/V4 support, see the new standalone [pact-verifier](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_verifier_cli#standalone-pact-verifier)
1516

1617
## Installation
1718

@@ -199,6 +200,22 @@ The following flags are required to use basic authentication with a Pact Broker:
199200

200201
NOTE: the `http://user:password@host` format for basic HTTP auth is not supported.
201202

203+
## Compatibility
204+
205+
<details><summary>Specification Compatibility</summary>
206+
207+
| Version | Stable | [Spec] Compatibility |
208+
| ------- | ------ | -------------------- |
209+
| 1.x.x | Yes | 2, 3\* |
210+
211+
_\*_ v3 support is limited to the subset of functionality required to enable language inter-operable [Message support].
212+
213+
See V3 tracking [issue](https://github.com/pact-foundation/pact-ruby/issues/318) for more detail
214+
215+
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)
216+
217+
[message support]: https://github.com/pact-foundation/pact-specification/tree/version-3#introduces-messages-for-services-that-communicate-via-event-streams-and-message-queues
218+
202219
## Contributing
203220

204221
See [CONTRIBUTING.md](/CONTRIBUTING.md)

0 commit comments

Comments
 (0)