Skip to content

Commit 49d5f7c

Browse files
committed
docs: update README.md with relevant option documentation
1 parent 5a99528 commit 49d5f7c

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,9 +347,15 @@ requests.
347347

348348
The URL which should be called to setup a specific provider state before a Pact is verified. This URL will be called with a POST request, and the JSON body `{consumer: 'Consumer name', state: 'a thing exists'}`.
349349

350+
###### --pact-broker-url
351+
352+
Base URl for the Pact Broker instance to publish pacts to. Can also be specified via the environment variable
353+
`PACT_BROKER_BASE_URL`.
354+
350355
###### --pact-broker-username
351356

352-
The username to use when contacting the Pact Broker.
357+
The username to use when contacting the Pact Broker. Can also be specified via the environment variable
358+
`PACT_BROKER_USERNAME`.
353359

354360
###### --pact-broker-password
355361

@@ -361,6 +367,37 @@ as the environment variable `PACT_BROKER_PASSWORD`.
361367
The bearer token to use when contacting the Pact Broker. You can also specify this value
362368
as the environment variable `PACT_BROKER_TOKEN`.
363369

370+
###### --consumer-version-tag
371+
372+
Retrieve the latest pacts with this consumer version tag. Used in conjunction with `--provider`.
373+
May be specified multiple times.
374+
375+
###### --consumer-version-selector
376+
377+
You can also retrieve pacts with consumer version selector, a more flexible approach in specifying which pacts you need.
378+
May be specified multiple times. Read more about selectors [here](https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors/).
379+
380+
###### --provider-version-tag
381+
382+
Tag to apply to the provider application version. May be specified multiple times.
383+
384+
###### --custom-provider-header
385+
386+
Header to add to provider state set up and pact verification requests e.g.`Authorization: Basic cGFjdDpwYWN0`
387+
May be specified multiple times.
388+
389+
###### -t, --timeout
390+
391+
The duration in seconds we should wait to confirm that the verification process was successful. Defaults to 30.
392+
393+
###### -a, --provider-app-version
394+
395+
The provider application version. Required for publishing verification results.
396+
397+
###### -r, --publish-verification-results
398+
399+
Publish verification results to the broker.
400+
364401
### Python API
365402
You can use the Verifier class. This has all the same parameters as the cli tool but allows you to write native python code and the test framework of your choice.
366403

RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
1. Increment the version according to semantic versioning rules in `pact/__version__.py`
44

5-
2. To upgrade the the versions of `pact-mock_service` and `pact-provider-verifier`, change the
5+
2. To upgrade the versions of `pact-mock_service` and `pact-provider-verifier`, change the
66
`PACT_STANDALONE_VERSION` in `setup.py` to match the latest version available from the
77
[pact-ruby-standalone](https://github.com/pact-foundation/pact-ruby-standalone/releases) repository.
88

0 commit comments

Comments
 (0)