Skip to content

Commit

Permalink
Merge pull request #124 from pact-foundation/docs/pact_spec_compat
Browse files Browse the repository at this point in the history
docs: add pact spec compat notes and warning
  • Loading branch information
YOU54F authored Aug 13, 2024
2 parents 4ae7ae1 + bcd1e5b commit 041a091
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ This setup simplifies Pact Provider [verification](https://docs.pact.io/document
process in any language, wrapping the Ruby implementation into a cross-platform,
binary-like CLI tool.

[![Build Status](https://travis-ci.org/pact-foundation/pact-provider-verifier.svg?branch=master)](https://travis-ci.org/pact-foundation/pact-provider-verifier)
[![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)

**Features**:

* Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/pact-foundation/pact_broker)
* Verify local `*.json` Pacts on the file system
* Works with Pact [provider states](https://docs.pact.io/getting_started/provider_states) should you need them
* Publishes the verification results back to the pact broker if the pact was retrieved from a broker.
* ⚠️ - 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)

## Installation

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

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

## Compatibility

<details><summary>Specification Compatibility</summary>

| 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) for more detail

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

## Contributing

See [CONTRIBUTING.md](/CONTRIBUTING.md)
Expand Down

0 comments on commit 041a091

Please sign in to comment.