From 855ab642ec7160cc4985f376538e2f84695d128e Mon Sep 17 00:00:00 2001 From: "tien.xuan.vo" Date: Wed, 3 Apr 2024 20:22:54 +0700 Subject: [PATCH 1/3] docs: Use table to show supported specifications --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c2850b76..f897f9ac 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,13 @@ If you wish to stick with the 2.X implementation, you can continue to pull from ## Specifications -The 3.X version is the version of Pact-PHP, not the pact specification version that it supports. - -Pact-Php 3.X -> 9.X supports [Pact-Specification 2.X](https://github.com/pact-foundation/pact-specification/tree/version-2). -Pact-Php 10.X supports: - * [Pact-Specification 2.X](https://github.com/pact-foundation/pact-specification/tree/version-2) - * [Pact-Specification 3.X](https://github.com/pact-foundation/pact-specification/tree/version-3). - * [Pact-Specification 4.X](https://github.com/pact-foundation/pact-specification/tree/version-4). +| Specification | Supported | Pact-PHP Version | +| ------------- | --------- | ---------------- | +| 1 | ✅ | 1.x + | +| 1.1 | ✅ | 1.x + | +| 2 | ✅ | 2.x + | +| 3 | ✅ | 10.x + | +| 4 | ✅ | 10.x + | ##  Supported Platforms From a3ff61560048041f1306d6c7ad25534716f4740a Mon Sep 17 00:00:00 2001 From: "tien.xuan.vo" Date: Wed, 3 Apr 2024 22:21:40 +0700 Subject: [PATCH 2/3] docs: Use the spec table format from pact-js --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f897f9ac..0579d5e3 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,19 @@ If you wish to stick with the 2.X implementation, you can continue to pull from ## Specifications -| Specification | Supported | Pact-PHP Version | -| ------------- | --------- | ---------------- | -| 1 | ✅ | 1.x + | -| 1.1 | ✅ | 1.x + | -| 2 | ✅ | 2.x + | -| 3 | ✅ | 10.x + | -| 4 | ✅ | 10.x + | +| Version | Status | [Spec] Compatibility | Install | +| ------- | ---------- | -------------------- | ------------------ | +| 10.x | Alpha | 2, 3, 4 | See [installation] | +| 9.x | Stable | 2, 3\* | [9xx] | +| 8.x | Deprecated | 2, 3\* | | +| 7.x | Deprecated | 2, 3\* | | +| 6.x | Deprecated | 2, 3\* | | +| 5.x | Deprecated | 2, 3\* | | +| 4.x | Deprecated | 2 | | +| 3.x | Deprecated | 2 | | +| 2.x | Deprecated | 2 | | + +_\*_ v3 support is limited to the subset of functionality required to enable language inter-operable [Message support]. ##  Supported Platforms @@ -450,3 +456,8 @@ $response = $client->get($this->config->getBaseUri() . '/' . $endpoint); echo $response->getBody(); // output: {"results":[{"name":"Games"}]} ``` + +[spec]: https://github.com/pact-foundation/pact-specification +[installation]: #installation +[9xx]: https://github.com/pact-foundation/pact-php/tree/release/9.x +[message support]: https://github.com/pact-foundation/pact-specification/tree/version-3#introduces-messages-for-services-that-communicate-via-event-streams-and-message-queues From 611071081883f3a06e4bf8574e3b242cca542c6b Mon Sep 17 00:00:00 2001 From: tienvx Date: Mon, 8 Apr 2024 18:11:00 +0700 Subject: [PATCH 3/3] docs: Pact specification v1 and v1.1 compatibility --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0579d5e3..43da745b 100644 --- a/README.md +++ b/README.md @@ -68,15 +68,16 @@ If you wish to stick with the 2.X implementation, you can continue to pull from | Version | Status | [Spec] Compatibility | Install | | ------- | ---------- | -------------------- | ------------------ | -| 10.x | Alpha | 2, 3, 4 | See [installation] | -| 9.x | Stable | 2, 3\* | [9xx] | -| 8.x | Deprecated | 2, 3\* | | -| 7.x | Deprecated | 2, 3\* | | -| 6.x | Deprecated | 2, 3\* | | -| 5.x | Deprecated | 2, 3\* | | -| 4.x | Deprecated | 2 | | -| 3.x | Deprecated | 2 | | -| 2.x | Deprecated | 2 | | +| 10.x | Alpha | 1, 1.1, 2, 3, 4 | See [installation] | +| 9.x | Stable | 1, 1.1, 2, 3\* | [9xx] | +| 8.x | Deprecated | 1, 1.1, 2, 3\* | | +| 7.x | Deprecated | 1, 1.1, 2, 3\* | | +| 6.x | Deprecated | 1, 1.1, 2, 3\* | | +| 5.x | Deprecated | 1, 1.1, 2, 3\* | | +| 4.x | Deprecated | 1, 1.1, 2 | | +| 3.x | Deprecated | 1, 1.1, 2 | | +| 2.x | Deprecated | 1, 1.1, 2 | | +| 1.x | Deprecated | 1, 1.1 | | _\*_ v3 support is limited to the subset of functionality required to enable language inter-operable [Message support].