Skip to content

Commit

Permalink
docs: update stability table in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mefellows committed Jul 10, 2023
1 parent 0539cc2 commit 1e8dbe4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 28 deletions.
28 changes: 1 addition & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Please provide the following information with your issue to enable us to respond
You can run the E2E tests by:

```sh
make tools # Assemble the latest Pact Go from Ruby and compile Go
make pact # Run the Pact tests - consumer + provider
```

Expand All @@ -38,29 +37,4 @@ npm install commitizen -g
npm i -g cz-conventional-changelog
```

`git cz` to commit and commitizen will guide you.

### Developing

For full integration testing locally, Ruby 2.2.0 must be installed. Under the
hood, Pact Go bundles the
[Pact Mock Service](https://github.com/bethesque/pact-mock_service) and
[Pact Provider Verifier](https://github.com/pact-foundation/pact-provider-verifier)
projects to implement up to v2.0 of the Pact Specification. This is only
temporary, until [Pact Reference](https://github.com/pact-foundation/pact-reference/)
work is completed.

* Git clone https://github.com/pact-foundation/pact-go.git
* Run `make dev` to build the package and setup the Ruby 'binaries' locally

#### Vendoring

We use [dep](https://github.com/golang/dep) to vendor packages. Please ensure
any new packages that need to have a specific version locked are added to `Gopkg.toml`.

## Integration Tests

Before releasing a new version, in addition to the standard (isolated) tests
we smoke test the key features against the latest code and Broker.

Run `make pact` to run the integration tests.
`git cz` to commit and commitizen will guide you.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ func TestV3HTTPProvider(t *testing.T) {

| Version | Stable | [Spec] Compatibility | Install |
| ------- | ------ | -------------------- | ------------------ |
| 2.0.x | Beta | 2, 3 | See [installation] |
| 2.0.x | Yes | 2, 3, 4 | See [installation] |
| 1.0.x | Yes | 2, 3\* | 1.x.x [1xx] |
| 0.x.x | Yes | Up to v2 | 0.x.x [stable] |

Expand Down

0 comments on commit 1e8dbe4

Please sign in to comment.