pact_broker-client 1.73.0 → 1.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfeaaf44e2dc8a19f90bd55795542da931dec46853371ea5a51955ccb1f3a39f
-  data.tar.gz: c9d00e81e65a20bc6f8a0b38c5c2af2c135e05266906f3b7bd45207a8f7e7b07
+  metadata.gz: c5089c183a535af491e824cdb9d198cb06150cb44d77014b09957564b9a47be7
+  data.tar.gz: 4d86ae219d734f0d4266214d1adca636f4557691104e75a720e8860d4103f831
 SHA512:
-  metadata.gz: 521599522cf724dd5f0f28becbcc7faf2695c45e1050892ae0494573dc220d22427712548d4a1c5395d7caf9d59263405ff4b8158fdc2634ba8416292afc3447
-  data.tar.gz: 987e4569edfac0db3e0bc81483b67cee1d73803422e4dea145456dd61dd7afdad2ad632190cba28eb91501069fce9aa6a49b661cb6398be8a865a6dd681a81aa
+  metadata.gz: 4f7e075d702ae824e91835cfbf14068c8c2938877cc0a156f7d99e8f9a577bd41d4b4507f06f714897c8f911e7c85f647f94898d4eb0ebf1ea938b270d004708
+  data.tar.gz: e7f787f092e10fec2166328a1bca16c7517a5a1c65179f92e4b9b71f6a97caaf0633a0ecc71f03cc0b9baaf303a86d26567a11399ff8fcd9a00d1de54685f856

data/.github/workflows/release_gem.yml

@@ -29,7 +29,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: pact-foundation/release-gem@v0.0.14
+    - uses: pact-foundation/release-gem@v1
       id: release
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
@@ -61,7 +61,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Notify ${{ matrix.repository }} of gem release
-        uses: peter-evans/repository-dispatch@v1
+        uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
           repository: ${{ matrix.repository }}

data/.github/workflows/test.yml

@@ -1,6 +1,9 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   test:

data/.github/workflows/trigger_pact_docs_update.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Trigger docs.pact.io update workflow
-        uses: peter-evans/repository-dispatch@v1
+        uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.GHTOKENFORTRIGGERINGPACTDOCSUPDATE }}
           repository: pact-foundation/docs.pact.io

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+<a name="v1.75.0"></a>
+### v1.75.0 (2023-11-11)
+
+#### Features
+
+* add support for delete-branch command (#151)	 ([6da6202](/../../commit/6da6202))
+
+#### Bug Fixes
+
+* set correct Accept header when publishing provider contracts	 ([abc8ea3](/../../commit/abc8ea3))
+
+<a name="v1.74.0"></a>
+### v1.74.0 (2023-10-14)
+
+#### Features
+
+* auto detect commit sha, add shorthand -r flag (#119)	 ([1dac9f8](/../../commit/1dac9f8))
+
+#### Bug Fixes
+
+* support merging v3 pacts	 ([d1e01d0](/../../commit/d1e01d0))
+
 <a name="v1.73.0"></a>
 ### v1.73.0 (2023-10-13)
 

data/Gemfile

@@ -25,4 +25,5 @@ end
 group :test do
   gem 'faraday', '~>2.0'
   gem 'faraday-retry', '~>2.0'
+  gem 'rackup', '~> 2.1'
 end

data/README.md

@@ -59,18 +59,19 @@ In the next major version, an error will be raised by default.
 
 ```
 Usage:
-  pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
+  pact-broker publish PACT_DIRS_OR_FILES ... -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --consumer-app-version=CONSUMER_APP_VERSION
+  -a, [--consumer-app-version=CONSUMER_APP_VERSION]
               # The consumer application version
   -h, [--branch=BRANCH]
               # Repository branch of the consumer version
-      [--auto-detect-version-properties], [--no-auto-detect-version-properties]
-              # Automatically detect the repository branch from known CI
-                environment variables or git CLI. Supports Buildkite, Circle
-                CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor,
-                GitLab, CodeShip, Bitbucket and Azure DevOps.
+  -r, [--auto-detect-version-properties], [--no-auto-detect-version-properties]
+              # Automatically detect the repository commit, branch and build
+                URL from known CI environment variables or git CLI. Supports
+                Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins,
+                Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps.
+              # Default: false
   -t, [--tag=TAG]
               # Tag name for consumer version. Can be specified multiple
                 times.
@@ -78,13 +79,15 @@ Options:
               # Tag consumer version with the name of the current git branch.
                 Supports Buildkite, Circle CI, Travis CI, GitHub Actions,
                 Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and
-                Azure DevOps. Default: false
+                Azure DevOps.
+              # Default: false
       [--build-url=BUILD_URL]
               # The build URL that created the pact
       [--merge], [--no-merge]
               # If a pact already exists for this consumer version and
                 provider, merge the contents. Useful when running Pact tests
                 concurrently on different build nodes.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or text
               # Default: text
@@ -97,7 +100,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Publish pacts to a Pact Broker.
@@ -118,7 +122,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or table
               # Default: table
@@ -142,7 +147,8 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                This is currently informational only. Default: false
+                This is currently informational only.
+              # Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -160,7 +166,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Create an environment resource in the Pact Broker to represent a real world deployment or release environment.
@@ -181,7 +188,8 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                This is currently informational only. Default: false
+                This is currently informational only.
+              # Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -199,7 +207,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Update an environment resource in the Pact Broker.
@@ -225,7 +234,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describe an environment
@@ -251,7 +261,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Delete an environment
@@ -275,7 +286,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 List environments
@@ -316,7 +328,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record deployment of a pacticipant version to an environment. See https://docs.pact.io/record-deployment for more information.
@@ -356,7 +369,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -392,7 +406,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record release of a pacticipant version to an environment. See See https://docs.pact.io/record-release for more information.
@@ -422,7 +437,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record the end of support for a pacticipant version in an environment. See https://docs.pact.io/record-support-ended for more information.
@@ -459,6 +475,7 @@ Options:
               # Use the latest version of the configured main branch of the
                 pacticipant as the version for which you want to check the
                 verification results
+              # Default: false
       [--to-environment=ENVIRONMENT]
               # The environment into which the pacticipant(s) are to be
                 deployed
@@ -488,6 +505,7 @@ Options:
                 is recommended to use the environment variable and just set it
                 for the build required to deploy that particular version, so
                 you don't accidentally leave the dry run mode enabled.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -497,7 +515,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -575,6 +594,7 @@ Options:
                 is recommended to use the environment variable and just set it
                 for the build required to deploy that particular version, so
                 you don't accidentally leave the dry run mode enabled.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -584,7 +604,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -619,7 +640,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Create or update pacticipant by name
@@ -645,7 +667,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describe a pacticipant
@@ -669,7 +692,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 List pacticipants
@@ -731,7 +755,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -796,7 +821,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
       --uuid=UUID
               # Specify the uuid for the webhook
 ```
@@ -827,11 +853,44 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Test the execution of a webhook
 
+### Branches
+
+#### delete-branch
+
+```
+Usage:
+  pact-broker delete-branch --branch=BRANCH -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --pacticipant=PACTICIPANT
+              # The name of the pacticipant that the branch belongs to.
+      --branch=BRANCH
+              # The pacticipant branch name.
+      [--error-when-not-found], [--no-error-when-not-found]
+              # Raise an error if the branch that is to be deleted is not
+                found.
+              # Default: true
+  -b, --broker-base-url=BROKER_BASE_URL
+              # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+              # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+              # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+              # Pact Broker bearer token
+  -v, [--verbose], [--no-verbose]
+              # Verbose output.
+              # Default: false
+```
+
+Deletes a pacticipant branch. Does not delete the versions or pacts/verifications associated with the branch, but does make the pacts inaccessible for verification via consumer versions selectors or WIP pacts.
+
 ### Tags
 
 #### create-version-tag
@@ -850,10 +909,12 @@ Options:
                 times.
       [--auto-create-version], [--no-auto-create-version]
               # Automatically create the pacticipant version if it does not
-                exist. Default: false
+                exist.
+              # Default: false
   -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
               # Tag pacticipant version with the name of the current git
-                branch. Default: false
+                branch.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -863,7 +924,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Add a tag to a pacticipant version
@@ -896,7 +958,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describes a pacticipant version. If no version or tag is specified, the latest version is described.
@@ -926,7 +989,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or text
               # Default: text
@@ -1002,7 +1066,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Publish provider contract to PactFlow

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -38,6 +38,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-branch_relation_exists_in_the_index_resource) given the pb:pacticipant-branch relation exists in the index resource
+
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource) given the pb:pacticipant-version and pb:environments relations exist in the index resource
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource) given the pb:publish-contracts relations exists in the index resource
@@ -76,6 +78,8 @@
 
 * [A request to create a webhook with every possible event type](#a_request_to_create_a_webhook_with_every_possible_event_type_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to delete a pacticipant branch](#a_request_to_delete_a_pacticipant_branch_given_a_branch_named_main_exists_for_pacticipant_Foo) given a branch named main exists for pacticipant Foo
+
 * [A request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5](#a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod) given provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod
 
 * [A request to get the Pricing Service](#a_request_to_get_the_Pricing_Service_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
@@ -827,6 +831,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-branch_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-branch relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant-branch": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-{pacticipant}-{branch}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource"></a>
 Given **the pb:pacticipant-version and pb:environments relations exist in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -1766,6 +1797,20 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_delete_a_pacticipant_branch_given_a_branch_named_main_exists_for_pacticipant_Foo"></a>
+Given **a branch named main exists for pacticipant Foo**, upon receiving **a request to delete a pacticipant branch** from Pact Broker Client, with
+```json
+{
+  "method": "DELETE",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-Foo-main"
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 204
+}
+```
 <a name="a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod"></a>
 Given **provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod**, upon receiving **a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5** from Pact Broker Client, with
 ```json

data/doc/pacts/markdown/Pact Broker Client - Pactflow.md

@@ -210,7 +210,7 @@ Upon receiving **a request to publish a provider contract** from Pact Broker Cli
   "path": "/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-Bar",
   "headers": {
     "Content-Type": "application/json",
-    "Accept": "application/hal+json"
+    "Accept": "application/hal+json,application/problem+json"
   },
   "body": {
     "pacticipantVersionNumber": "1",

data/example/scripts/publish-pact-rake.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_TOKEN already
+
+bundle exec rake pact:publish:pactflow_auto_on_nil_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_on_user_commit_user_branch
+bundle exec rake pact:publish:pactflow_auto_on_user_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_on_nil_commit_user_branch
+bundle exec rake pact:publish:pactflow_auto_off_user_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_off_nil_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_off_empty_string_commit_nil_branch

data/example/scripts/publish-pact.sh

@@ -1,3 +1,27 @@
 # assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Must be executed from root directory of project.
 
-bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version=1.0.0 --tag master --verbose
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override --auto-detect-version-properties --tag-with-git-branch
+
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override -r -g

data/example/scripts/publish-provider-contract.sh

@@ -1,4 +1,5 @@
-# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Must be executed from root directory of project.
 
 bundle exec bin/pactflow publish-provider-contract $(dirname "$0")/oas.yml \
     --provider pactflow-cli-test-provider \

data/lib/pact_broker/client/branches/delete_branch.rb

@@ -0,0 +1,64 @@
+require "pact_broker/client/base_command"
+
+module PactBroker
+  module Client
+    module Branches
+      class DeleteBranch < PactBroker::Client::BaseCommand
+
+        NOT_SUPPORTED_MESSAGE_PACT_BROKER = "This version of the Pact Broker does not support deleting branches. Please upgrade to version 2.108.0 or later."
+        NOT_SUPPORTED_MESSAGE_PACTFLOW = "This version of PactFlow does not support deleting branches. Please upgrade to the latest version."
+
+        def initialize(params, options, pact_broker_client_options)
+        	super
+          @pacticipant_name = params.fetch(:pacticipant)
+        	@branch_name = params.fetch(:branch)
+          @error_when_not_found = params.fetch(:error_when_not_found)
+        end
+
+				def do_call
+					check_if_command_supported
+          @deleted_resource = branch_link.delete
+          PactBroker::Client::CommandResult.new(success?, result_message)
+        end
+
+        private
+
+        attr_reader :pacticipant_name, :branch_name, :error_when_not_found, :deleted_resource
+
+        def branch_link
+          index_resource._link("pb:pacticipant-branch").expand(pacticipant: pacticipant_name, branch: branch_name)
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:pacticipant-branch")
+          	raise PactBroker::Client::Error.new(is_pactflow? ? NOT_SUPPORTED_MESSAGE_PACTFLOW : NOT_SUPPORTED_MESSAGE_PACT_BROKER)
+          end
+        end
+
+        def success?
+          if deleted_resource.success?
+            true
+          elsif deleted_resource.response.status == 404 && !error_when_not_found
+            true
+          else
+            false
+          end
+        end
+
+        def result_message
+          if deleted_resource.success?
+					 green("Successfully deleted branch #{branch_name} of pacticipant #{pacticipant_name}")
+          elsif deleted_resource.response.status == 404
+            if error_when_not_found
+              red("Could not delete branch #{branch_name} of pacticipant #{pacticipant_name} as it was not found")
+            else
+              green("Branch #{branch_name} of pacticipant #{pacticipant_name} not found")
+            end
+          else
+            red(deleted_resource.response.raw_body)
+          end
+        end
+      end
+    end
+  end
+end