pact_broker-client 1.49.0 → 1.50.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test.yml +1 -1
  3. data/CHANGELOG.md +8 -0
  4. data/README.md +661 -230
  5. data/doc/CAN_I_DEPLOY_USAGE_WITH_TAGS.md +107 -0
  6. data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md +0 -2
  7. data/example/scripts/verify-changed-pact.sh +30 -0
  8. data/lib/pact_broker/client/cli/can_i_deploy_long_desc.txt +13 -98
  9. data/lib/pact_broker/client/cli/environment_commands.rb +1 -1
  10. data/lib/pact_broker/client/cli/matrix_commands.rb +2 -2
  11. data/lib/pact_broker/client/cli/webhook_commands.rb +5 -0
  12. data/lib/pact_broker/client/matrix/abbreviate_version_number.rb +27 -5
  13. data/lib/pact_broker/client/version.rb +1 -1
  14. data/script/update-cli-usage-in-readme.rb +152 -0
  15. data/spec/lib/pact_broker/client/matrix/abbreviate_version_number_spec.rb +42 -0
  16. data/spec/pacts/pact_broker_client-pact_broker.json +0 -2
  17. data/spec/readme_spec.rb +16 -0
  18. data/spec/service_providers/pact_broker_client_create_version_spec.rb +0 -1
  19. metadata +10 -6
  20. data/doc/markdown/Pact Broker Client - Pact Broker.md +0 -582
  21. data/doc/markdown/README.md +0 -3
  22. data/script/generate-cli-usage.sh +0 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a5c2b5906de55da5afb0461b51468d56834ab580efe7e3329c5b3b17b4c57ae4
4
- data.tar.gz: f452f6412fd031c4e4114c60516e058d1e6fe7b5211200c1543ab2f0e2e67c32
3
+ metadata.gz: ebb0899f37221475b93ac43b01a535aa03a0f991fcf367556e83697f293873b8
4
+ data.tar.gz: 1627a56a6fc1302c6bc381786c4a6f385485fa26a75cded5b3630ffb5afa1809
5
5
  SHA512:
6
- metadata.gz: 0a344ebc2e27870f7b053608df5dae99bb38b81c8555baa51bf08b0d9be6d85d4e7a5755fa1615d7463363fd1d77890ffbdb374d8395115e9a50cc18b4607e50
7
- data.tar.gz: 68828a17238b5c0d4e2f98c17f75b8bcba175191eea226ffe77e63a3bf1a972b5c09b6d52d23040cd9b2b325d77216c7fff879f18d6976a5361463f52203ddef
6
+ metadata.gz: 45636dfd9a5b865d870baf6147833562365e4fbf9fbbe80b9b0d5f34779defd3dacec69ddf1772167a65ab17da6389d8c7f183764e594fc23b85cecfe15b60ca
7
+ data.tar.gz: 02d6f6a5a7514a32711179de4667bd57a247c440d6c95c046eacd291b0a31bf2eff89f9027bf79a0f14bf78fcb45aa9102b415c0945bee13477de539bfa4f4f8
data/.github/workflows/test.yml CHANGED
@@ -1,6 +1,6 @@
1
1
  name: Test
2
2
 
3
- on: push
3
+ on: [push, pull_request]
4
4
 
5
5
  jobs:
6
6
  test:
data/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ <a name="v1.50.0"></a>
2
+ ### v1.50.0 (2021-08-16)
3
+
4
+ #### Features
5
+
6
+ * add support for creating webhooks with event contract_requiring_verification_published (feature toggled off) ([4d4bc4b](/../../commit/4d4bc4b))
7
+ * trim long versions on can-i-deploy formatting (#91) ([86d21e1](/../../commit/86d21e1))
8
+
1
9
  <a name="v1.49.0"></a>
2
10
  ### v1.49.0 (2021-08-05)
3
11
 
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Pact Broker Client
2
2
 
3
- A client for the Pact Broker. Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
3
+ A client for the [Pact Broker](https://docs.pact.io/pact_broker/). Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
4
4
 
5
5
  ![Build status](https://github.com/pact-foundation/pact_broker-client/workflows/Test/badge.svg)
6
6
 
@@ -10,7 +10,15 @@ A client for the Pact Broker. Publishes and retrieves pacts, verification result
10
10
 
11
11
  ## Installation
12
12
 
13
- ### CLI
13
+ ### Docker
14
+
15
+ The Pact Broker CLI is packaged with the other Ruby command line tools in the [pactfoundation/pact-cli](https://hub.docker.com/r/pactfoundation/pact-cli) Docker image.
16
+
17
+ ```
18
+ docker pull pactfoundation/pact-cli:latest
19
+ ```
20
+
21
+ ### Standalone executable
14
22
 
15
23
  Download the latest [pact-ruby-standalone][pact-ruby-standalone] package. You do not need Ruby to run the CLI, as the Ruby runtime is packaged with the executable using Travelling Ruby.
16
24
 
@@ -30,344 +38,767 @@ Pact Broker authentication can be performed either using basic auth or a bearer
30
38
 
31
39
  Basic auth parameters can be specified using the `$PACT_BROKER_USERNAME` and `$PACT_BROKER_PASSWORD` environment variables, or the `-u` or `--broker-username` and `-p` or `--broker-password` parameters.
32
40
 
33
- Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This authentication system is used by [Pactflow](pactflow.io).
41
+ Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This bearer token authentication is used by [Pactflow](https://pactflow.io) and is not available in the [OSS Pact Broker](https://docs.pact.io/pact_broker/), which only supports basic auth.
42
+
43
+
44
+ <!-- start-autogenerated-docs -->
34
45
 
35
- ### publish
46
+ ### Pacts
47
+
48
+ #### publish
36
49
 
37
50
  ```
38
51
  Usage:
39
52
  pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
40
53
 
41
54
  Options:
42
- -a, --consumer-app-version=CONSUMER_APP_VERSION # The consumer application version
43
- -b, --broker-base-url=BROKER_BASE_URL # The base URL of the Pact Broker
44
- -u, [--broker-username=BROKER_USERNAME] # Pact Broker basic auth username
45
- -p, [--broker-password=BROKER_PASSWORD] # Pact Broker basic auth password
46
- -k, [--broker-token=BROKER_TOKEN] # Pact Broker bearer token
47
- -t, [--tag=TAG] # Tag name for consumer version. Can be specified multiple times.
48
- -g, [--tag-with-git-branch], [--no-tag-with-git-branch] # Tag consumer version with the name of the current git branch. Default: false
49
- -v, [--verbose], [--no-verbose] # Verbose output. Default: false
55
+ -a, --consumer-app-version=CONSUMER_APP_VERSION
56
+ # The consumer application version
57
+ -h, [--branch=BRANCH]
58
+ # Repository branch of the consumer version
59
+ [--auto-detect-version-properties], [--no-auto-detect-version-properties]
60
+ # Automatically detect the repository branch from known CI
61
+ environment variables or git CLI.
62
+ -t, [--tag=TAG]
63
+ # Tag name for consumer version. Can be specified multiple
64
+ times.
65
+ -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
66
+ # Tag consumer version with the name of the current git branch.
67
+ Default: false
68
+ [--build-url=BUILD_URL]
69
+ # The build URL that created the pact
70
+ [--merge], [--no-merge]
71
+ # If a pact already exists for this consumer version and
72
+ provider, merge the contents. Useful when running Pact tests
73
+ concurrently on different build nodes.
74
+ -o, [--output=OUTPUT]
75
+ # json or text
76
+ # Default: text
77
+ -b, --broker-base-url=BROKER_BASE_URL
78
+ # The base URL of the Pact Broker
79
+ -u, [--broker-username=BROKER_USERNAME]
80
+ # Pact Broker basic auth username
81
+ -p, [--broker-password=BROKER_PASSWORD]
82
+ # Pact Broker basic auth password
83
+ -k, [--broker-token=BROKER_TOKEN]
84
+ # Pact Broker bearer token
85
+ -v, [--verbose], [--no-verbose]
86
+ # Verbose output. Default: false
87
+ ```
50
88
 
51
89
  Publish pacts to a Pact Broker.
90
+
91
+ #### list-latest-pact-versions
92
+
93
+ ```
94
+ Usage:
95
+ pact-broker list-latest-pact-versions -b, --broker-base-url=BROKER_BASE_URL
96
+
97
+ Options:
98
+ -b, --broker-base-url=BROKER_BASE_URL
99
+ # The base URL of the Pact Broker
100
+ -u, [--broker-username=BROKER_USERNAME]
101
+ # Pact Broker basic auth username
102
+ -p, [--broker-password=BROKER_PASSWORD]
103
+ # Pact Broker basic auth password
104
+ -k, [--broker-token=BROKER_TOKEN]
105
+ # Pact Broker bearer token
106
+ -v, [--verbose], [--no-verbose]
107
+ # Verbose output. Default: false
108
+ -o, [--output=OUTPUT]
109
+ # json or table
110
+ # Default: table
52
111
  ```
53
112
 
54
- ### create-version-tag
113
+ List the latest pact for each integration
114
+
115
+ ### Environments
116
+
117
+ #### create-environment
55
118
 
56
119
  ```
120
+ Usage:
121
+ pact-broker create-environment --name=NAME -b, --broker-base-url=BROKER_BASE_URL
122
+
57
123
  Options:
58
- -a, --pacticipant=PACTICIPANT # The pacticipant name
59
- -e, --version=VERSION # The pacticipant version
60
- -t, [--tag=TAG] # Tag name for pacticipant version. Can be specified multiple times.
61
- [--auto-create-version], [--no-auto-create-version] # Automatically create the pacticipant version if it does not exist. Default: false
62
- -g, [--tag-with-git-branch], [--no-tag-with-git-branch] # Tag pacticipant version with the name of the current git branch. Default: false
63
- -b, --broker-base-url=BROKER_BASE_URL # The base URL of the Pact Broker
64
- -u, [--broker-username=BROKER_USERNAME] # Pact Broker basic auth username
65
- -p, [--broker-password=BROKER_PASSWORD] # Pact Broker basic auth password
66
- -k, [--broker-token=BROKER_TOKEN] # Pact Broker bearer token
67
- -v, [--verbose], [--no-verbose] # Verbose output. Default: false
124
+ --name=NAME
125
+ # The uniquely identifying name of the environment as used in
126
+ deployment code
127
+ [--display-name=DISPLAY_NAME]
128
+ # The display name of the environment
129
+ [--production], [--no-production]
130
+ # Whether or not this environment is a production environment.
131
+ Default: false
132
+ [--contact-name=CONTACT_NAME]
133
+ # The name of the team/person responsible for this environment
134
+ [--contact-email-address=CONTACT_EMAIL_ADDRESS]
135
+ # The email address of the team/person responsible for this
136
+ environment
137
+ -o, [--output=OUTPUT]
138
+ # json or text
139
+ # Default: text
140
+ -b, --broker-base-url=BROKER_BASE_URL
141
+ # The base URL of the Pact Broker
142
+ -u, [--broker-username=BROKER_USERNAME]
143
+ # Pact Broker basic auth username
144
+ -p, [--broker-password=BROKER_PASSWORD]
145
+ # Pact Broker basic auth password
146
+ -k, [--broker-token=BROKER_TOKEN]
147
+ # Pact Broker bearer token
148
+ -v, [--verbose], [--no-verbose]
149
+ # Verbose output. Default: false
150
+ ```
151
+
152
+ Create an environment resource in the Pact Broker to represent a real world deployment or release environment.
153
+
154
+ #### update-environment
68
155
 
69
- Add a tag to a pacticipant version
70
156
  ```
157
+ Usage:
158
+ pact-broker update-environment --uuid=UUID -b, --broker-base-url=BROKER_BASE_URL
71
159
 
72
- ### can-i-deploy
160
+ Options:
161
+ --uuid=UUID
162
+ # The UUID of the environment to update
163
+ [--name=NAME]
164
+ # The uniquely identifying name of the environment as used in
165
+ deployment code
166
+ [--display-name=DISPLAY_NAME]
167
+ # The display name of the environment
168
+ [--production], [--no-production]
169
+ # Whether or not this environment is a production environment.
170
+ Default: false
171
+ [--contact-name=CONTACT_NAME]
172
+ # The name of the team/person responsible for this environment
173
+ [--contact-email-address=CONTACT_EMAIL_ADDRESS]
174
+ # The email address of the team/person responsible for this
175
+ environment
176
+ -o, [--output=OUTPUT]
177
+ # json or text
178
+ # Default: text
179
+ -b, --broker-base-url=BROKER_BASE_URL
180
+ # The base URL of the Pact Broker
181
+ -u, [--broker-username=BROKER_USERNAME]
182
+ # Pact Broker basic auth username
183
+ -p, [--broker-password=BROKER_PASSWORD]
184
+ # Pact Broker basic auth password
185
+ -k, [--broker-token=BROKER_TOKEN]
186
+ # Pact Broker bearer token
187
+ -v, [--verbose], [--no-verbose]
188
+ # Verbose output. Default: false
189
+ ```
190
+
191
+ Update an environment resource in the Pact Broker.
73
192
 
74
- You will need >= v2.13.0 of the Pact Broker for this feature to work. See the [Can I Deploy](https://docs.pact.io/pact_broker/can_i_deploy) page in the Pact docs for an explanation of how `can-i-deploy` works under the hood.
193
+ #### describe-environment
75
194
 
76
195
  ```
77
196
  Usage:
78
- pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
197
+ pact-broker describe-environment --uuid=UUID -b, --broker-base-url=BROKER_BASE_URL
79
198
 
80
199
  Options:
81
- -a, --pacticipant=PACTICIPANT
82
- # The pacticipant name. Use once for each pacticipant being checked.
83
- -e, [--version=VERSION]
84
- # The pacticipant version. Must be entered after the --pacticipant that it relates to.
85
- [--ignore=IGNORE]
86
- # The pacticipant name to ignore. Use once for each pacticipant being ignored.
87
- A specific version can be ignored by also specifying a --version after the
88
- pacticipant name option.
89
- -l, [--latest=[TAG]]
90
- # Use the latest pacticipant version. Optionally specify a TAG to use the
91
- latest version with the specified tag.
92
- [--to=TAG]
93
- # This is too hard to explain in a short sentence. Look at the examples.
94
- -o, [--output=OUTPUT]
95
- # json or table
200
+ --uuid=UUID
201
+ # The UUID of the environment to describe
202
+ -o, [--output=OUTPUT]
203
+ # json or text
204
+ # Default: text
205
+ -b, --broker-base-url=BROKER_BASE_URL
206
+ # The base URL of the Pact Broker
207
+ -u, [--broker-username=BROKER_USERNAME]
208
+ # Pact Broker basic auth username
209
+ -p, [--broker-password=BROKER_PASSWORD]
210
+ # Pact Broker basic auth password
211
+ -k, [--broker-token=BROKER_TOKEN]
212
+ # Pact Broker bearer token
213
+ -v, [--verbose], [--no-verbose]
214
+ # Verbose output. Default: false
215
+ ```
96
216
 
97
- # Default: table
98
- [--retry-while-unknown=TIMES]
99
- # The number of times to retry while there is an unknown verification result
100
- (ie. the provider verification is likely still running)
217
+ Describe an environment
101
218
 
102
- # Default: 0
103
- [--retry-interval=SECONDS]
104
- # The time between retries in seconds. Use in conjuction with --retry-while-unknown
219
+ #### delete-environment
105
220
 
106
- # Default: 10
107
- [--dry-run], [--no-dry-run]
108
- # When enabled, always exits process with a success code. Can also be enabled by setting
109
- the environment variable PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true.
110
- -b, --broker-base-url=BROKER_BASE_URL
111
- # The base URL of the Pact Broker
112
- -u, [--broker-username=BROKER_USERNAME]
113
- # Pact Broker basic auth username
114
- -p, [--broker-password=BROKER_PASSWORD]
115
- # Pact Broker basic auth password
116
- -k, [--broker-token=BROKER_TOKEN]
117
- # Pact Broker bearer token
118
- -v, [--verbose], [--no-verbose]
119
- # Verbose output. Default: false
120
221
  ```
222
+ Usage:
223
+ pact-broker delete-environment --uuid=UUID -b, --broker-base-url=BROKER_BASE_URL
121
224
 
122
- Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) versions are compatible (ie. safe to deploy). Prints out the relevant pact/verification details, indicating any missing or failed verification results.
225
+ Options:
226
+ --uuid=UUID
227
+ # The UUID of the environment to delete
228
+ -o, [--output=OUTPUT]
229
+ # json or text
230
+ # Default: text
231
+ -b, --broker-base-url=BROKER_BASE_URL
232
+ # The base URL of the Pact Broker
233
+ -u, [--broker-username=BROKER_USERNAME]
234
+ # Pact Broker basic auth username
235
+ -p, [--broker-password=BROKER_PASSWORD]
236
+ # Pact Broker basic auth password
237
+ -k, [--broker-token=BROKER_TOKEN]
238
+ # Pact Broker bearer token
239
+ -v, [--verbose], [--no-verbose]
240
+ # Verbose output. Default: false
241
+ ```
123
242
 
124
- The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD may be used instead of their respective command line options.
243
+ Delete an environment
125
244
 
126
- There are two ways to use `can-i-deploy`. The first (recommended and most commonly used) approach is to specify just the application version you want to deploy and let the Pact Broker work out the dependencies for you. The second approach is to specify each application version explicitly. This would generally only be used if there were limitations that stopped you being able to use the first approach.
245
+ #### list-environments
127
246
 
128
- #### Specifying an application version
247
+ ```
248
+ Usage:
249
+ pact-broker list-environments -b, --broker-base-url=BROKER_BASE_URL
129
250
 
130
- To specify an application (pacticipant) version you need to provide:
251
+ Options:
252
+ -o, [--output=OUTPUT]
253
+ # json or text
254
+ # Default: text
255
+ -b, --broker-base-url=BROKER_BASE_URL
256
+ # The base URL of the Pact Broker
257
+ -u, [--broker-username=BROKER_USERNAME]
258
+ # Pact Broker basic auth username
259
+ -p, [--broker-password=BROKER_PASSWORD]
260
+ # Pact Broker basic auth password
261
+ -k, [--broker-token=BROKER_TOKEN]
262
+ # Pact Broker bearer token
263
+ -v, [--verbose], [--no-verbose]
264
+ # Verbose output. Default: false
265
+ ```
131
266
 
132
- * the name of the application using the `--pacticipant PACTICIPANT` parameter,
133
- * directly followed by *one* of the following parameters:
134
- * `--version VERSION` to specify a known application version (recommended)
135
- * `--latest` to specify the latest version
136
- * `--latest TAG` to specify the latest version that has a particular tag
137
- * `--all TAG` to specify all the versions that have a particular tag (eg. "all prod" versions). This would be used when ensuring you have backwards compatiblity with all production mobile clients for a provider. Note, when using this option, you need to specify dependency explicitly (see the second usage option).
267
+ List environments
138
268
 
139
- Using a specific version is the easiest way to ensure you get an accurate response that won't be affected by race conditions.
269
+ ### Deployments
140
270
 
141
- #### Recommended usage - allowing the Pact Broker to automatically determine the dependencies
271
+ #### record-deployment
142
272
 
143
- If you would like the Pact Broker to calculate the dependencies for you when you want to deploy an application into a given environment, you will need to let the Broker know which version of each application is in that environment. To do this, the relevant application version resource in the Broker will need to be "tagged" with the name of the environment during the deployment process:
273
+ ```
274
+ Usage:
275
+ pact-broker record-deployment --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
144
276
 
145
- $ pact-broker create-version-tag --pacticipant Foo --version 173153ae0 --tag test
277
+ Options:
278
+ -a, --pacticipant=PACTICIPANT
279
+ # The name of the pacticipant that was deployed.
280
+ -e, --version=VERSION
281
+ # The pacticipant version number that was deployed.
282
+ --environment=ENVIRONMENT
283
+ # The name of the environment that the pacticipant version was
284
+ deployed to.
285
+ [--target=TARGET]
286
+ # Optional. The target of the deployment - a logical identifer
287
+ required to differentiate deployments when there are multiple
288
+ instances of the same application in an environment.
289
+ -o, [--output=OUTPUT]
290
+ # json or text
291
+ # Default: text
292
+ -b, --broker-base-url=BROKER_BASE_URL
293
+ # The base URL of the Pact Broker
294
+ -u, [--broker-username=BROKER_USERNAME]
295
+ # Pact Broker basic auth username
296
+ -p, [--broker-password=BROKER_PASSWORD]
297
+ # Pact Broker basic auth password
298
+ -k, [--broker-token=BROKER_TOKEN]
299
+ # Pact Broker bearer token
300
+ -v, [--verbose], [--no-verbose]
301
+ # Verbose output. Default: false
302
+ ```
146
303
 
147
- This allows you to use the following simple command to find out if you are safe to deploy:
304
+ Record deployment of a pacticipant version to an environment. See https://docs.pact.io/record-deployment for more information.
148
305
 
149
- $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION \
150
- --to ENVIRONMENT \
151
- --broker-base-url BROKER_BASE_URL
306
+ #### record-undeployment
152
307
 
153
- If the `--to` tag is omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
308
+ ```
309
+ Usage:
310
+ pact-broker record-undeployment --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
154
311
 
155
- Examples:
312
+ Options:
313
+ -a, --pacticipant=PACTICIPANT
314
+ # The name of the pacticipant that was undeployed.
315
+ --environment=ENVIRONMENT
316
+ # The name of the environment that the pacticipant version was
317
+ undeployed from.
318
+ [--target=TARGET]
319
+ # Optional. The target that the application is being undeployed
320
+ from - a logical identifer required to differentiate
321
+ deployments when there are multiple instances of the same
322
+ application in an environment.
323
+ -o, [--output=OUTPUT]
324
+ # json or text
325
+ # Default: text
326
+ -b, --broker-base-url=BROKER_BASE_URL
327
+ # The base URL of the Pact Broker
328
+ -u, [--broker-username=BROKER_USERNAME]
329
+ # Pact Broker basic auth username
330
+ -p, [--broker-password=BROKER_PASSWORD]
331
+ # Pact Broker basic auth password
332
+ -k, [--broker-token=BROKER_TOKEN]
333
+ # Pact Broker bearer token
334
+ -v, [--verbose], [--no-verbose]
335
+ # Verbose output. Default: false
336
+ ```
156
337
 
338
+ Description:
339
+ Note that use of this command is only required if you are permanently removing an application instance from an environment. It is not required if you are
340
+ deploying over a previous version, as record-deployment will automatically mark the previously deployed version as undeployed for you. See
341
+ https://docs.pact.io/record-undeployment for more information.
157
342
 
158
- Can I deploy version 173153ae0 of application Foo to the test environment?
343
+ ### Releases
159
344
 
345
+ #### record-release
160
346
 
161
- $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
162
- --to test \
163
- --broker-base-url https://my-pact-broker
347
+ ```
348
+ Usage:
349
+ pact-broker record-release --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
164
350
 
351
+ Options:
352
+ -a, --pacticipant=PACTICIPANT
353
+ # The name of the pacticipant that was released.
354
+ -e, --version=VERSION
355
+ # The pacticipant version number that was released.
356
+ --environment=ENVIRONMENT
357
+ # The name of the environment that the pacticipant version was
358
+ released to.
359
+ -o, [--output=OUTPUT]
360
+ # json or text
361
+ # Default: text
362
+ -b, --broker-base-url=BROKER_BASE_URL
363
+ # The base URL of the Pact Broker
364
+ -u, [--broker-username=BROKER_USERNAME]
365
+ # Pact Broker basic auth username
366
+ -p, [--broker-password=BROKER_PASSWORD]
367
+ # Pact Broker basic auth password
368
+ -k, [--broker-token=BROKER_TOKEN]
369
+ # Pact Broker bearer token
370
+ -v, [--verbose], [--no-verbose]
371
+ # Verbose output. Default: false
372
+ ```
165
373
 
166
- Can I deploy the latest version of application Foo with the latest version of each of the applications it integrates to?
374
+ Record release of a pacticipant version to an environment. See See https://docs.pact.io/record-release for more information.
167
375
 
376
+ #### record-support-ended
168
377
 
169
- $ pact-broker can-i-deploy --pacticipant Foo --latest \
170
- --broker-base-url https://my-pact-broker
378
+ ```
379
+ Usage:
380
+ pact-broker record-support-ended --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
171
381
 
382
+ Options:
383
+ -a, --pacticipant=PACTICIPANT
384
+ # The name of the pacticipant.
385
+ -e, --version=VERSION
386
+ # The pacticipant version number for which support is ended.
387
+ --environment=ENVIRONMENT
388
+ # The name of the environment in which the support is ended.
389
+ -o, [--output=OUTPUT]
390
+ # json or text
391
+ # Default: text
392
+ -b, --broker-base-url=BROKER_BASE_URL
393
+ # The base URL of the Pact Broker
394
+ -u, [--broker-username=BROKER_USERNAME]
395
+ # Pact Broker basic auth username
396
+ -p, [--broker-password=BROKER_PASSWORD]
397
+ # Pact Broker basic auth password
398
+ -k, [--broker-token=BROKER_TOKEN]
399
+ # Pact Broker bearer token
400
+ -v, [--verbose], [--no-verbose]
401
+ # Verbose output. Default: false
402
+ ```
172
403
 
173
- Can I deploy the latest version of the application Foo that has the tag "test" to the "prod" environment?
404
+ Record the end of support for a pacticipant version in an environment. See https://docs.pact.io/record-support-ended for more information.
174
405
 
175
- $ pact-broker can-i-deploy --pacticipant Foo --latest test \
176
- --to prod \
177
- --broker-base-url https://my-pact-broker
406
+ ### Matrix
178
407
 
408
+ #### can-i-deploy
179
409
 
410
+ ```
411
+ Usage:
412
+ pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
180
413
 
181
- #### Alternate usage - specifying dependencies explicitly
414
+ Options:
415
+ -a, --pacticipant=PACTICIPANT
416
+ # The pacticipant name. Use once for each pacticipant being
417
+ checked.
418
+ -e, [--version=VERSION]
419
+ # The pacticipant version. Must be entered after the
420
+ --pacticipant that it relates to.
421
+ [--ignore=IGNORE]
422
+ # The pacticipant name to ignore. Use once for each pacticipant
423
+ being ignored. A specific version can be ignored by also
424
+ specifying a --version after the pacticipant name option.
425
+ -l, [--latest=[TAG]]
426
+ # Use the latest pacticipant version. Optionally specify a TAG
427
+ to use the latest version with the specified tag.
428
+ [--to-environment=ENVIRONMENT]
429
+ # The environment into which the pacticipant(s) are to be
430
+ deployed
431
+ [--to=TAG]
432
+ # The tag that represents the branch or environment of the
433
+ integrated applications for which you want to check the
434
+ verification result status.
435
+ -o, [--output=OUTPUT]
436
+ # json or table
437
+ # Default: table
438
+ [--retry-while-unknown=TIMES]
439
+ # The number of times to retry while there is an unknown
440
+ verification result (ie. the provider verification is likely
441
+ still running)
442
+ # Default: 0
443
+ [--retry-interval=SECONDS]
444
+ # The time between retries in seconds. Use in conjuction with
445
+ --retry-while-unknown
446
+ # Default: 10
447
+ [--dry-run], [--no-dry-run]
448
+ # When dry-run is enabled, always exit process with a success
449
+ code. Can also be enabled by setting the environment variable
450
+ PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true.
451
+ -b, --broker-base-url=BROKER_BASE_URL
452
+ # The base URL of the Pact Broker
453
+ -u, [--broker-username=BROKER_USERNAME]
454
+ # Pact Broker basic auth username
455
+ -p, [--broker-password=BROKER_PASSWORD]
456
+ # Pact Broker basic auth password
457
+ -k, [--broker-token=BROKER_TOKEN]
458
+ # Pact Broker bearer token
459
+ -v, [--verbose], [--no-verbose]
460
+ # Verbose output. Default: false
461
+ ```
182
462
 
183
- If you are unable to use tags, or there is some other limitation that stops you from using the recommended approach, you can specify one or more of the dependencies explictly. You must also do this if you want to use the `--all TAG` option for any of the pacticipants.
463
+ Description:
464
+ Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) has a successful verification result with each of the application
465
+ versions that are already deployed to a particular environment. Prints out the relevant pact/verification details, indicating any missing or failed
466
+ verification results.
184
467
 
185
- You can specify as many application versions as you like, and you can even specify multiple versions of the same application (repeat the `--pacticipant` name and supply a different version). If you have a monorepo and you deploy a group of applications together, you can either call `can-i-deploy` once for each application, or you can group them all together by specifying a `--pacticipant` and `--version` for each sub-application.
468
+ 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
469
+ support for environments, deployments and releases. For documentation on how to use can-i-deploy with tags, please see
470
+ https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
186
471
 
187
- You can use explictly declared dependencies with or without the `--to ENVIRONMENT`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
472
+ 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"
473
+ and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
474
+ https://docs.pact.io/pact_broker/client_cli/readme#environments for more information.
188
475
 
189
- If you are finding that your dependencies are not being automatically included when you supply multiple pacticipant versions, please upgrade to the latest version of the Pact Broker, as this is a more recently added feature.
476
+ $ pact-broker create-environment --name "uat" --display-name "UAT" --no-production
190
477
 
478
+ After an application is deployed or released, its deployment must be recorded using the `record-deployment` or `record-release` commands. See
479
+ https://docs.pact.io/pact_broker/recording_deployments_and_releases/ for more information.
191
480
 
192
- $ pact-broker can-i-deploy --pacticipant PACTICIPANT_1 [--version VERSION_1 | --latest [TAG_1] | --all TAG_1] \
193
- --pacticipant PACTICIPANT_2 [--version VERSION_2 | --latest [TAG_2] | --all TAG_2] \
194
- [--to ENVIRONMENT] \
195
- --broker-base-url BROKER_BASE_URL
481
+ $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment uat
196
482
 
197
- Examples:
483
+ 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
484
+ the versions of each integrated application that are already in that environment.
198
485
 
486
+ $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
199
487
 
200
- Can I deploy version Foo version 173153ae0 and Bar version ac23df1e8 together?
488
+ Example: can I deploy version 173153ae0 of application Foo to the test environment?
201
489
 
490
+ $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
202
491
 
203
- $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
204
- --pacticipant Bar --version ac23df1e8 \
205
- --broker-base-url BROKER_BASE_URL
492
+ 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
493
+ from the main branch of another application" it functions as a "can I merge" check.
206
494
 
495
+ $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
207
496
 
208
- Can I deploy the latest version of Foo with tag "master" and the latest version of Bar with tag "master" together?
497
+ ### Pacticipants
209
498
 
210
- $ pact-broker can-i-deploy --pacticipant Foo --latest master \
211
- --pacticipant Bar --latest master \
212
- --broker-base-url BROKER_BASE_URL
499
+ #### create-or-update-pacticipant
213
500
 
214
- Can I deploy all the applications in my monorepo to prod?
501
+ ```
502
+ Usage:
503
+ pact-broker create-or-update-pacticipant --name=NAME -b, --broker-base-url=BROKER_BASE_URL
215
504
 
216
- $ pact-broker can-i-deploy --pacticipant A --version a7e28207 \
217
- --pacticipant B --version a7e28207 \
218
- --pacticipant C --version a7e28207 \
219
- --to prod \
220
- --broker-base-url BROKER_BASE_URL
505
+ Options:
506
+ --name=NAME
507
+ # Pacticipant name
508
+ [--display-name=DISPLAY_NAME]
509
+ # Display name
510
+ [--repository-url=REPOSITORY_URL]
511
+ # The repository URL of the pacticipant
512
+ -o, [--output=OUTPUT]
513
+ # json or text
514
+ # Default: text
515
+ -b, --broker-base-url=BROKER_BASE_URL
516
+ # The base URL of the Pact Broker
517
+ -u, [--broker-username=BROKER_USERNAME]
518
+ # Pact Broker basic auth username
519
+ -p, [--broker-password=BROKER_PASSWORD]
520
+ # Pact Broker basic auth password
521
+ -k, [--broker-token=BROKER_TOKEN]
522
+ # Pact Broker bearer token
523
+ -v, [--verbose], [--no-verbose]
524
+ # Verbose output. Default: false
525
+ ```
221
526
 
222
- Mobile provider use case - can I deploy version b80e7b1b of Bar, all versions of Foo with tag "prod", and the latest version tagged "prod" of any other automatically calculated dependencies together? (Eg. where Bar is a provider and Foo is a mobile consumer with multiple versions in production, and Bar also has its own providers it needs to be compatible with.)
527
+ Create or update pacticipant by name
223
528
 
529
+ #### describe-pacticipant
224
530
 
225
- $ pact-broker can-i-deploy --pacticipant Bar --version b80e7b1b \
226
- --pacticipant Foo --all prod \
227
- --to prod \
228
- --broker-base-url BROKER_BASE_URL
531
+ ```
532
+ Usage:
533
+ pact-broker describe-pacticipant --name=NAME -b, --broker-base-url=BROKER_BASE_URL
229
534
 
230
- ### create-webhook
535
+ Options:
536
+ --name=NAME
537
+ # Pacticipant name
538
+ -o, [--output=OUTPUT]
539
+ # json or text
540
+ # Default: text
541
+ -b, --broker-base-url=BROKER_BASE_URL
542
+ # The base URL of the Pact Broker
543
+ -u, [--broker-username=BROKER_USERNAME]
544
+ # Pact Broker basic auth username
545
+ -p, [--broker-password=BROKER_PASSWORD]
546
+ # Pact Broker basic auth password
547
+ -k, [--broker-token=BROKER_TOKEN]
548
+ # Pact Broker bearer token
549
+ -v, [--verbose], [--no-verbose]
550
+ # Verbose output. Default: false
551
+ ```
552
+
553
+ Describe a pacticipant
554
+
555
+ #### list-pacticipants
556
+
557
+ ```
558
+ Usage:
559
+ pact-broker list-pacticipants -b, --broker-base-url=BROKER_BASE_URL
560
+
561
+ Options:
562
+ -o, [--output=OUTPUT]
563
+ # json or text
564
+ # Default: text
565
+ -b, --broker-base-url=BROKER_BASE_URL
566
+ # The base URL of the Pact Broker
567
+ -u, [--broker-username=BROKER_USERNAME]
568
+ # Pact Broker basic auth username
569
+ -p, [--broker-password=BROKER_PASSWORD]
570
+ # Pact Broker basic auth password
571
+ -k, [--broker-token=BROKER_TOKEN]
572
+ # Pact Broker bearer token
573
+ -v, [--verbose], [--no-verbose]
574
+ # Verbose output. Default: false
575
+ ```
576
+
577
+ List pacticipants
578
+
579
+ ### Webhooks
580
+
581
+ #### create-webhook
231
582
 
232
583
  ```
233
584
  Usage:
234
585
  pact-broker create-webhook URL -X, --request=METHOD -b, --broker-base-url=BROKER_BASE_URL
235
586
 
236
587
  Options:
237
- -X, --request=METHOD
238
- # Webhook HTTP method
239
- -H, [--header=one two three]
240
- # Webhook Header
241
- -d, [--data=DATA]
242
- # Webhook payload (file or string)
243
- -u, [--user=USER]
244
- # Webhook basic auth username and password eg. username:password
245
- [--consumer=CONSUMER]
246
- # Consumer name
247
- [--provider=PROVIDER]
248
- # Provider name
249
- [--description=DESCRIPTION]
250
- # Webhook description
251
- [--contract-content-changed], [--no-contract-content-changed]
252
- # Trigger this webhook when the pact content changes
253
- [--contract-published], [--no-contract-published]
254
- # Trigger this webhook when a pact is published
255
- [--provider-verification-published], [--no-provider-verification-published]
256
- # Trigger this webhook when a provider verification result is published
257
- [--provider-verification-failed], [--no-provider-verification-failed]
258
- # Trigger this webhook when a failed provider verification result is published
259
- [--provider-verification-succeeded], [--no-provider-verification-succeeded]
260
- # Trigger this webhook when a successful provider verification result is published
261
- [--team-uuid=UUID]
262
- # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
263
- -b, --broker-base-url=BROKER_BASE_URL
264
- # The base URL of the Pact Broker
265
- -u, [--broker-username=BROKER_USERNAME]
266
- # Pact Broker basic auth username
267
- -p, [--broker-password=BROKER_PASSWORD]
268
- # Pact Broker basic auth password
269
- -k, [--broker-token=BROKER_TOKEN]
270
- # Pact Broker bearer token
271
- -v, [--verbose], [--no-verbose]
272
- # Verbose output. Default: false
588
+ -X, --request=METHOD
589
+ # Webhook HTTP method
590
+ -H, [--header=one two three]
591
+ # Webhook Header
592
+ -d, [--data=DATA]
593
+ # Webhook payload (file or string)
594
+ -u, [--user=USER]
595
+ # Webhook basic auth username and password eg. username:password
596
+ [--consumer=CONSUMER]
597
+ # Consumer name
598
+ [--provider=PROVIDER]
599
+ # Provider name
600
+ [--description=DESCRIPTION]
601
+ # Webhook description
602
+ [--contract-content-changed], [--no-contract-content-changed]
603
+ # Trigger this webhook when the pact content changes
604
+ [--contract-published], [--no-contract-published]
605
+ # Trigger this webhook when a pact is published
606
+ [--provider-verification-published], [--no-provider-verification-published]
607
+ # Trigger this webhook when a provider verification result is
608
+ published
609
+ [--provider-verification-failed], [--no-provider-verification-failed]
610
+ # Trigger this webhook when a failed provider verification
611
+ result is published
612
+ [--provider-verification-succeeded], [--no-provider-verification-succeeded]
613
+ # Trigger this webhook when a successful provider verification
614
+ result is published
615
+ [--team-uuid=UUID]
616
+ # UUID of the Pactflow team to which the webhook should be
617
+ assigned (Pactflow only)
618
+ -b, --broker-base-url=BROKER_BASE_URL
619
+ # The base URL of the Pact Broker
620
+ -u, [--broker-username=BROKER_USERNAME]
621
+ # Pact Broker basic auth username
622
+ -p, [--broker-password=BROKER_PASSWORD]
623
+ # Pact Broker basic auth password
624
+ -k, [--broker-token=BROKER_TOKEN]
625
+ # Pact Broker bearer token
626
+ -v, [--verbose], [--no-verbose]
627
+ # Verbose output. Default: false
628
+ ```
273
629
 
274
630
  Description:
275
- Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker
276
- create-webhook" and add the consumer, provider, event types and broker details. Note that the URL must be the first parameter
277
- when executing create-webhook.
278
- ```
631
+ Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the consumer,
632
+ provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
279
633
 
280
- ### create-or-update-webhook
634
+ Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
635
+ option. Please use the --broker-username or environment variable for the Pact Broker username.
636
+
637
+ #### create-or-update-webhook
281
638
 
282
639
  ```
283
640
  Usage:
284
641
  pact-broker create-or-update-webhook URL --uuid=UUID -X, --request=METHOD -b, --broker-base-url=BROKER_BASE_URL
285
642
 
286
643
  Options:
287
- -X, --request=METHOD
288
- # Webhook HTTP method
289
- -H, [--header=one two three]
290
- # Webhook Header
291
- -d, [--data=DATA]
292
- # Webhook payload (file or string)
293
- -u, [--user=USER]
294
- # Webhook basic auth username and password eg. username:password
295
- [--consumer=CONSUMER]
296
- # Consumer name
297
- [--provider=PROVIDER]
298
- # Provider name
299
- [--description=DESCRIPTION]
300
- # Webhook description
301
- [--contract-content-changed], [--no-contract-content-changed]
302
- # Trigger this webhook when the pact content changes
303
- [--contract-published], [--no-contract-published]
304
- # Trigger this webhook when a pact is published
305
- [--provider-verification-published], [--no-provider-verification-published]
306
- # Trigger this webhook when a provider verification result is published
307
- [--provider-verification-failed], [--no-provider-verification-failed]
308
- # Trigger this webhook when a failed provider verification result is published
309
- [--provider-verification-succeeded], [--no-provider-verification-succeeded]
310
- # Trigger this webhook when a successful provider verification result is published
311
- [--team-uuid=UUID]
312
- # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
313
- -b, --broker-base-url=BROKER_BASE_URL
314
- # The base URL of the Pact Broker
315
- -u, [--broker-username=BROKER_USERNAME]
316
- # Pact Broker basic auth username
317
- -p, [--broker-password=BROKER_PASSWORD]
318
- # Pact Broker basic auth password
319
- -k, [--broker-token=BROKER_TOKEN]
320
- # Pact Broker bearer token
321
- -v, [--verbose], [--no-verbose]
322
- # Verbose output. Default: false
323
- --uuid=UUID
324
- # Specify the uuid for the webhook
644
+ -X, --request=METHOD
645
+ # Webhook HTTP method
646
+ -H, [--header=one two three]
647
+ # Webhook Header
648
+ -d, [--data=DATA]
649
+ # Webhook payload (file or string)
650
+ -u, [--user=USER]
651
+ # Webhook basic auth username and password eg. username:password
652
+ [--consumer=CONSUMER]
653
+ # Consumer name
654
+ [--provider=PROVIDER]
655
+ # Provider name
656
+ [--description=DESCRIPTION]
657
+ # Webhook description
658
+ [--contract-content-changed], [--no-contract-content-changed]
659
+ # Trigger this webhook when the pact content changes
660
+ [--contract-published], [--no-contract-published]
661
+ # Trigger this webhook when a pact is published
662
+ [--provider-verification-published], [--no-provider-verification-published]
663
+ # Trigger this webhook when a provider verification result is
664
+ published
665
+ [--provider-verification-failed], [--no-provider-verification-failed]
666
+ # Trigger this webhook when a failed provider verification
667
+ result is published
668
+ [--provider-verification-succeeded], [--no-provider-verification-succeeded]
669
+ # Trigger this webhook when a successful provider verification
670
+ result is published
671
+ [--team-uuid=UUID]
672
+ # UUID of the Pactflow team to which the webhook should be
673
+ assigned (Pactflow only)
674
+ -b, --broker-base-url=BROKER_BASE_URL
675
+ # The base URL of the Pact Broker
676
+ -u, [--broker-username=BROKER_USERNAME]
677
+ # Pact Broker basic auth username
678
+ -p, [--broker-password=BROKER_PASSWORD]
679
+ # Pact Broker basic auth password
680
+ -k, [--broker-token=BROKER_TOKEN]
681
+ # Pact Broker bearer token
682
+ -v, [--verbose], [--no-verbose]
683
+ # Verbose output. Default: false
684
+ --uuid=UUID
685
+ # Specify the uuid for the webhook
686
+ ```
325
687
 
326
688
  Description:
327
- Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker
328
- create-or-update-webhook" and add the consumer, provider, event types and broker details. Note that the URL must be the first
329
- parameter when executing create-or-update-webhook and a uuid must also be provided. You can generate a valid UUID by using
330
- the `generate-uuid` command.
331
- ```
689
+ Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and add the
690
+ consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid must
691
+ also be provided. You can generate a valid UUID by using the `generate-uuid` command.
692
+
693
+ Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
694
+ option. Please use the --broker-username or environment variable for the Pact Broker username.
332
695
 
333
- ### create-or-update-pacticipant
696
+ #### test-webhook
334
697
 
335
698
  ```
336
699
  Usage:
337
- pact-broker create-or-update-pacticipant --name=NAME -b, --broker-base-url=BROKER_BASE_URL
700
+ pact-broker test-webhook --uuid=UUID -b, --broker-base-url=BROKER_BASE_URL
338
701
 
339
702
  Options:
340
- --name=NAME # Pacticipant name
341
- [--repository-url=REPOSITORY_URL] # The repository URL of the pacticipant
342
- -b, --broker-base-url=BROKER_BASE_URL # The base URL of the Pact Broker
343
- -u, [--broker-username=BROKER_USERNAME] # Pact Broker basic auth username
344
- -p, [--broker-password=BROKER_PASSWORD] # Pact Broker basic auth password
345
- -k, [--broker-token=BROKER_TOKEN] # Pact Broker bearer token
346
- -v, [--verbose], [--no-verbose] # Verbose output. Default: false
703
+ --uuid=UUID
704
+ # Specify the uuid for the webhook
705
+ -b, --broker-base-url=BROKER_BASE_URL
706
+ # The base URL of the Pact Broker
707
+ -u, [--broker-username=BROKER_USERNAME]
708
+ # Pact Broker basic auth username
709
+ -p, [--broker-password=BROKER_PASSWORD]
710
+ # Pact Broker basic auth password
711
+ -k, [--broker-token=BROKER_TOKEN]
712
+ # Pact Broker bearer token
713
+ -v, [--verbose], [--no-verbose]
714
+ # Verbose output. Default: false
715
+ ```
716
+
717
+ Test the execution of a webhook
718
+
719
+ ### Tags
720
+
721
+ #### create-version-tag
347
722
 
348
- Create or update pacticipant by name
349
723
  ```
724
+ Usage:
725
+ pact-broker create-version-tag -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
350
726
 
351
- ### describe-version
727
+ Options:
728
+ -a, --pacticipant=PACTICIPANT
729
+ # The pacticipant name
730
+ -e, --version=VERSION
731
+ # The pacticipant version
732
+ -t, [--tag=TAG]
733
+ # Tag name for pacticipant version. Can be specified multiple
734
+ times.
735
+ [--auto-create-version], [--no-auto-create-version]
736
+ # Automatically create the pacticipant version if it does not
737
+ exist. Default: false
738
+ -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
739
+ # Tag pacticipant version with the name of the current git
740
+ branch. Default: false
741
+ -b, --broker-base-url=BROKER_BASE_URL
742
+ # The base URL of the Pact Broker
743
+ -u, [--broker-username=BROKER_USERNAME]
744
+ # Pact Broker basic auth username
745
+ -p, [--broker-password=BROKER_PASSWORD]
746
+ # Pact Broker basic auth password
747
+ -k, [--broker-token=BROKER_TOKEN]
748
+ # Pact Broker bearer token
749
+ -v, [--verbose], [--no-verbose]
750
+ # Verbose output. Default: false
751
+ ```
752
+
753
+ Add a tag to a pacticipant version
754
+
755
+ ### Versions
756
+
757
+ #### describe-version
352
758
 
353
759
  ```
354
760
  Usage:
355
761
  pact-broker describe-version -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
356
762
 
357
763
  Options:
358
- -a, --pacticipant=PACTICIPANT # The name of the pacticipant that the version belongs to.
359
- -e, [--version=VERSION] # The pacticipant version number.
360
- -l, [--latest=[TAG]] # Describe the latest pacticipant version. Optionally specify a TAG to describe the latest version with the specified tag.
361
- -b, --broker-base-url=BROKER_BASE_URL # The base URL of the Pact Broker
362
- -u, [--broker-username=BROKER_USERNAME] # Pact Broker basic auth username
363
- -p, [--broker-password=BROKER_PASSWORD] # Pact Broker basic auth password
364
- -k, [--broker-token=BROKER_TOKEN] # Pact Broker bearer token
365
- -o, [--output=OUTPUT] # json or table or id
366
- # Default: table
367
- -v, [--verbose], [--no-verbose] # Verbose output. Default: false
764
+ -a, --pacticipant=PACTICIPANT
765
+ # The name of the pacticipant that the version belongs to.
766
+ -e, [--version=VERSION]
767
+ # The pacticipant version number.
768
+ -l, [--latest=[TAG]]
769
+ # Describe the latest pacticipant version. Optionally specify a
770
+ TAG to describe the latest version with the specified tag.
771
+ -o, [--output=OUTPUT]
772
+ # json or table or id
773
+ # Default: table
774
+ -b, --broker-base-url=BROKER_BASE_URL
775
+ # The base URL of the Pact Broker
776
+ -u, [--broker-username=BROKER_USERNAME]
777
+ # Pact Broker basic auth username
778
+ -p, [--broker-password=BROKER_PASSWORD]
779
+ # Pact Broker basic auth password
780
+ -k, [--broker-token=BROKER_TOKEN]
781
+ # Pact Broker bearer token
782
+ -v, [--verbose], [--no-verbose]
783
+ # Verbose output. Default: false
784
+ ```
368
785
 
369
786
  Describes a pacticipant version. If no version or tag is specified, the latest version is described.
787
+
788
+ ### Miscellaneous
789
+
790
+ #### generate-uuid
791
+
370
792
  ```
793
+ Usage:
794
+ pact-broker generate-uuid
795
+
796
+ Options:
797
+ ```
798
+
799
+ Generate a UUID for use when calling create-or-update-webhook
800
+
801
+ <!-- end-autogenerated-docs -->
371
802
 
372
803
  ## Usage - Ruby
373
804