Skip to content

Commit a50aa47

Browse files
YOU54FYOU54F
committed
chore(release): version 2.0.2
[ci-skip]
1 parent 39a4127 commit a50aa47

File tree

2 files changed

+80
-46
lines changed

2 files changed

+80
-46
lines changed

‎README.md

+79-45
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Creates a standalone pact command line executable using the ruby pact implementa
66

77
## Package contents
88

9-
This version (2.0.1) of the Pact standalone executables package contains:
9+
This version (2.0.2) of the Pact standalone executables package contains:
1010

1111
* pact gem 1.63.0
1212
* pact-mock_service gem 3.11.2
@@ -57,16 +57,16 @@ Ruby is not required on the host platform, Ruby 3.2.2 is provided in the distrib
5757

5858
```
5959
Commands:
60-
pact-mock-service control # Run a Pact mock service control server.
61-
pact-mock-service control-restart # Start a Pact mock service control server.
62-
pact-mock-service control-start # Start a Pact mock service control server.
63-
pact-mock-service control-stop # Stop a Pact mock service control server.
64-
pact-mock-service help [COMMAND] # Describe available commands or one specific command
65-
pact-mock-service restart # Start or restart a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).
66-
pact-mock-service service # Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).
67-
pact-mock-service start # Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).
60+
pact-mock-service control # Run a Pact mock service control s...
61+
pact-mock-service control-restart # Start a Pact mock service control...
62+
pact-mock-service control-start # Start a Pact mock service control...
63+
pact-mock-service control-stop # Stop a Pact mock service control ...
64+
pact-mock-service help [COMMAND] # Describe available commands or on...
65+
pact-mock-service restart # Start or restart a mock service. ...
66+
pact-mock-service service # Start a mock service. If the cons...
67+
pact-mock-service start # Start a mock service. If the cons...
6868
pact-mock-service stop -p, --port=PORT # Stop a Pact mock service
69-
pact-mock-service version # Show the pact-mock-service gem version
69+
pact-mock-service version # Show the pact-mock-service gem ve...
7070
7171
Usage:
7272
pact-mock-service service
@@ -117,10 +117,16 @@ Options:
117117
[--sslkey=SSLKEY] # Specify the path to the SSL key to use when running the service over HTTPS
118118
119119
Description:
120-
Start a stub service with the given pact file(s) or directories. Pact URIs may be local file or directory paths, or HTTP. Include any basic auth details in the URL using the format
121-
https://USERNAME:PASSWORD@URI. Where multiple matching interactions are found, the interactions will be sorted by response status, and the first one will be returned. This may lead to some
122-
non-deterministic behaviour. If you are having problems with this, please raise it on the pact-dev google group, and we can discuss some potential enhancements. Note that only versions 1 and 2 of
123-
the pact specification are currently fully supported. Pacts using the v3 format may be used, however, any matching features added in v3 will currently be ignored.
120+
Start a stub service with the given pact file(s) or directories. Pact URIs
121+
may be local file or directory paths, or HTTP. Include any basic auth details
122+
in the URL using the format https://USERNAME:PASSWORD@URI. Where multiple
123+
matching interactions are found, the interactions will be sorted by response
124+
status, and the first one will be returned. This may lead to some
125+
non-deterministic behaviour. If you are having problems with this, please
126+
raise it on the pact-dev google group, and we can discuss some potential
127+
enhancements. Note that only versions 1 and 2 of the pact specification are
128+
currently fully supported. Pacts using the v3 format may be used, however,
129+
any matching features added in v3 will currently be ignored.
124130
125131
```
126132

@@ -170,18 +176,24 @@ Description:
170176
--enable-pending
171177
--include-wip-pacts-since
172178
173-
To verify a pact at a known URL (eg. when a verification is triggered by a 'contract content changed' webhook), pass in the
174-
pact URL(s) as the first argument(s) to the command, and do NOT set any of the other parameters apart from the base URL and credentials.
179+
To
180+
verify a pact at a known URL (eg. when a verification is triggered by a
181+
'contract content changed' webhook), pass in the pact URL(s) as the first
182+
argument(s) to the command, and do NOT set any of the other parameters apart
183+
from the base URL and credentials.
175184
176-
To publish verification results for either of the above scenarios, set:
185+
To publish verification results for either of the above
186+
scenarios, set:
177187
178188
--publish-verification-results (REQUIRED)
179189
--provider-app-version (REQUIRED)
180190
--provider-version-tag or --tag-with-git-branch
181191
182192
183-
Selectors: These are specified using JSON strings. The keys are 'tag' (the name of the consumer version tag), 'latest' (true|false), 'consumer', and 'fallbackTag'. For
184-
example '{\"tag\": \"master\", \"latest\": true}'. For a detailed explanation of selectors, see https://pact.io/selectors#consumer-version-selectors
193+
Selectors: These are specified using JSON strings.
194+
The keys are 'tag' (the name of the consumer version tag), 'latest'
195+
(true|false), 'consumer', and 'fallbackTag'. For example '{\"tag\":
196+
\"master\", \"latest\": true}'. For a detailed explanation of selectors, see https://pact.io/selectors#consumer-version-selectors
185197
186198
```
187199

@@ -246,36 +258,58 @@ Options:
246258
-v, [--verbose], [--no-verbose] # Verbose output. Default: false
247259
248260
Description:
249-
Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) has a successful verification result with each of the application versions that are already deployed to
250-
a particular environment. Prints out the relevant pact/verification details, indicating any missing or failed verification results.
251-
252-
The can-i-deploy tool was originally written to support specifying versions and dependencies using tags. This usage has now been superseded by first class support for environments, deployments and
253-
releases. For documentation on how to use can-i-deploy with tags, please see https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
254-
255-
Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The "test" and "production" environments will
256-
have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See https://docs.pact.io/pact_broker/client_cli/readme#environments for more
261+
Returns exit code 0 or 1, indicating whether or not the specified application
262+
(pacticipant) has a successful verification result with each of the
263+
application versions that are already deployed to a particular environment.
264+
Prints out the relevant pact/verification details, indicating any missing or
265+
failed verification results.
266+
267+
The can-i-deploy tool was originally written to support specifying versions
268+
and dependencies using tags. This usage has now been superseded by first
269+
class support for environments, deployments and releases. For documentation
270+
on how to use can-i-deploy with tags, please see
271+
https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
272+
273+
Before `can-i-deploy` can be used, the relevant environment resources must
274+
first be created in the Pact Broker using the `create-environment` command.
275+
The "test" and "production" environments will have been seeded for you. You
276+
can check the existing environments by running `pact-broker
277+
list-environments`. See
278+
https://docs.pact.io/pact_broker/client_cli/readme#environments for more
257279
information.
258280
259-
$ pact-broker create-environment --name "uat" --display-name "UAT" --no-production
281+
$ pact-broker create-environment --name "uat" --display-name "UAT"
282+
--no-production
260283
261-
After an application is deployed or released, its deployment must be recorded using the `record-deployment` or `record-release` commands. See
262-
https://docs.pact.io/pact_broker/recording_deployments_and_releases/ for more information.
284+
After an application is deployed or released, its deployment must be recorded
285+
using the `record-deployment` or `record-release` commands. See
286+
https://docs.pact.io/pact_broker/recording_deployments_and_releases/ for more
287+
information.
263288
264-
$ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment uat
289+
$ pact-broker record-deployment --pacticipant Foo --version 173153ae0
290+
--environment uat
265291
266-
Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy with the versions of each integrated
267-
application that are already in that environment.
292+
Before an application is deployed or released to an environment, the
293+
can-i-deploy command must be run to check that the application version is
294+
safe to deploy with the versions of each integrated application that are
295+
already in that environment.
268296
269-
$ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
297+
$ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION
298+
--to-environment ENVIRONMENT
270299
271-
Example: can I deploy version 173153ae0 of application Foo to the test environment?
300+
Example: can I deploy version 173153ae0 of application Foo to the test
301+
environment?
272302
273-
$ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
303+
$ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0
304+
--to-environment test
274305
275-
Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the latest version from the main branch of
276-
another application" it functions as a "can I merge" check.
306+
Can-i-deploy can also be used to check if arbitrary versions have a
307+
successful verification. When asking "Can I deploy this application version
308+
with the latest version from the main branch of another application" it
309+
functions as a "can I merge" check.
277310
278-
$ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
311+
$ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar
312+
--latest main
279313
280314
```
281315

@@ -327,9 +361,9 @@ Usage:
327361
328362
Options:
329363
[--pact-dir=PACT_DIR] # Directory containing the pacts
330-
# Default: /Users/saf/dev/pact-foundation/pact-ruby-standalone/build/tmp/spec/pacts
364+
# Default: /home/runner/work/pact-ruby-standalone/pact-ruby-standalone/build/tmp/spec/pacts
331365
[--doc-dir=DOC_DIR] # Documentation directory
332-
# Default: /Users/saf/dev/pact-foundation/pact-ruby-standalone/build/tmp/doc/pacts
366+
# Default: /home/runner/work/pact-ruby-standalone/pact-ruby-standalone/build/tmp/doc/pacts
333367
334368
Generate Pact documentation in markdown
335369
@@ -339,10 +373,10 @@ Generate Pact documentation in markdown
339373

340374
```
341375
Commands:
342-
pact-message help [COMMAND] # Describe available commands or one specific command
343-
pact-message reify # Take a JSON document with embedded pact matchers and return a concrete example
344-
pact-message update MESSAGE_JSON --consumer=CONSUMER --pact-dir=PACT_DIR --provider=PROVIDER # Update/create a pact. If MESSAGE_JSON is omitted or '-', it is read from stdin
345-
pact-message version # Show the pact-message gem version
376+
pact-message help [COMMAND] ...
377+
pact-message reify ...
378+
pact-message update MESSAGE_JSON --consumer=CONSUMER --pact-dir=PACT_DIR --...
379+
pact-message version ...
346380
347381
348382
```

‎VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.0.1
1+
2.0.2

0 commit comments

Comments
 (0)