pact_broker-client 1.35.0 → 1.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bf1176c39519652e60c6aab383a941a2dd5a1c8e968b746741a290e68c736e9
-  data.tar.gz: 04b1f3aa9f25b353e61eb558d393d108750cd97b4645fe81313b1d04dca33ba5
+  metadata.gz: e1c89727fa660ba02fd9ff0565b74bf269aada75bfe3b04bb6f117048b265ad9
+  data.tar.gz: f6c946f2ab43c4cc69550b2fee0740a1782604e7843ae9b6a582664b6ecaee82
 SHA512:
-  metadata.gz: cbb4fe27ce2979d3daea2c597ca7509b6d4136ac53d139a738fd672f30d114fcce23ce4f3ba3c108aef13ec88b9793715bf57ec05a2fda6255dfcd7ed9c99875
-  data.tar.gz: 443c3e2e5fb75bcbfa3850ce1498f859c45872145f813c50b260a9a7d28a32f5aa7618c1f55b0c798b34975ec7b35d7e44b0937c6bd2575dea1b86356eb8ca5b
+  metadata.gz: 8a9f685a78726d293dc5017f1a142aa1d981a020ff8bdeafa56666a378562cd6c6632449c9ae980dff634e5c5ee216b3eb867b221156d15437166421b8eb1c14
+  data.tar.gz: 2ac71e6f98f361c1262e3190eb6e8b9ec588de4bb2ae51df6cd0e2bc8f44f4b5ee38270acb1ac670d772069eeaaaa1baea98ec34104c5fa9b91fa3ad5db315c3

data/.github/workflows/release_gem.yml

@@ -4,6 +4,7 @@ on:
   repository_dispatch:
     types:
       - release-triggered
+  workflow_dispatch:
 
 jobs:
   test:

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+<a name="v1.38.1"></a>
+### v1.38.1 (2021-03-22)
+
+<a name="v1.38.0"></a>
+### v1.38.0 (2021-03-22)
+
+<a name="v1.37.1"></a>
+### v1.37.1 (2021-03-11)
+
+#### Bug Fixes
+
+* set username from PACT_BROKER_USERNAME environment variable correctly when -u specified for create-or-update-webhook and create-webhook	 ([2411396](/../../commit/2411396))
+
+<a name="v1.37.0"></a>
+### v1.37.0 (2021-03-01)
+
+#### Features
+
+* add record-deployment	 ([6e5e208](/../../commit/6e5e208))
+
+#### Bug Fixes
+
+* use refinement to add compact to Hash	 ([c2c1cab](/../../commit/c2c1cab))
+
+<a name="v1.36.0"></a>
+### v1.36.0 (2021-02-21)
+
+#### Features
+
+* **can-i-deploy**
+  * add --to-environment option	 ([05ae44c](/../../commit/05ae44c))
+
+* support version branch and build URL when publishing pacts	 ([a75f7df](/../../commit/a75f7df))
+
 <a name="v1.35.0"></a>
 ### v1.35.0 (2021-01-21)
 

data/Rakefile

@@ -31,6 +31,8 @@ end
 desc 'List provider states'
 task 'pact:list_provider_states' do
   require 'json'
+  require 'pact_broker/client/backports'
+
   puts Dir.glob("spec/pacts/**.json").collect { | pact_file |
     puts pact_file
     JSON.parse(File.read(pact_file))['interactions'].collect{ | interaction| interaction['providerState'] }

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

@@ -2,6 +2,12 @@
 
 #### Requests from Pact Broker Client to Pact Broker
 
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren't_test_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment
+
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
+
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist
+
 * [A request for the compatibility matrix for a pacticipant that does not exist](#a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist)
 
 * [A request for the compatibility matrix for all versions of Foo and Bar](#a_request_for_the_compatibility_matrix_for_all_versions_of_Foo_and_Bar_given_the_pact_for_Foo_version_1.2.3_and_1.2.4_has_been_verified_by_Bar_version_4.5.6) given the pact for Foo version 1.2.3 and 1.2.4 has been verified by Bar version 4.5.6
@@ -20,6 +26,8 @@
 
 * [A request for the compatibility matrix where only the version of Foo is specified](#a_request_for_the_compatibility_matrix_where_only_the_version_of_Foo_is_specified_given_the_pact_for_Foo_version_1.2.3_has_been_verified_by_Bar_version_4.5.6_and_version_5.6.7) given the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7
 
+* [A request for the environments](#a_request_for_the_environments_given_an_environment_with_name_test_exists) given an environment with name test exists
+
 * [A request for the index resource](#a_request_for_the_index_resource)
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pacticipant_relations_are_present) given the pacticipant relations are present
@@ -28,6 +36,10 @@
 
 * [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-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:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
+
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -42,6 +54,10 @@
 
 * [A request to create a pacticipant](#a_request_to_create_a_pacticipant)
 
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist
+
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist
+
 * [A request to create a webhook for a consumer and provider](#a_request_to_create_a_webhook_for_a_consumer_and_provider_given_'Condor'_does_not_exist_in_the_pact-broker) given 'Condor' does not exist in the pact-broker
 
 * [A request to create a webhook with a JSON body and a uuid](#a_request_to_create_a_webhook_with_a_JSON_body_and_a_uuid_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -76,6 +92,8 @@
 
 * [A request to publish a pact with method put](#a_request_to_publish_a_pact_with_method_put_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker,_and_Condor_already_has_a_pact_published_for_version_1.3.0) given the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0
 
+* [A request to record a deployment](#a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
+
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
 
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_does_not_exist_in_the_pact-broker) given the 'Pricing Service' does not exist in the pact-broker
@@ -108,6 +126,87 @@
 
 #### Interactions
 
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren&#39;t_test_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "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:record-deployment": [
+        {
+          "name": "prod",
+          "href": "href"
+        },
+        {
+          "name": "dev",
+          "href": "href"
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "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:record-deployment": [
+        {
+          "name": "test",
+          "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 404
+}
+```
 <a name="a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist"></a>
 Upon receiving **a request for the compatibility matrix for a pacticipant that does not exist** from Pact Broker Client, with
 ```json
@@ -529,6 +628,36 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_environments_given_an_environment_with_name_test_exists"></a>
+Given **an environment with name test exists**, upon receiving **a request for the environments** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+  "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:environments": [
+        {
+          "name": "test",
+          "href": "href"
+        }
+      ]
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource"></a>
 Upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -646,6 +775,63 @@ Pact Broker will respond with:
   }
 }
 ```
+<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
+{
+  "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-version": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      },
+      "pb:environments": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
+      }
+    }
+  }
+}
+```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-version 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-version": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -898,6 +1084,76 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_create_a_webhook_for_a_consumer_and_provider_given_&#39;Condor&#39;_does_not_exist_in_the_pact-broker"></a>
 Given **'Condor' does not exist in the pact-broker**, upon receiving **a request to create a webhook for a consumer and provider** from Pact Broker Client, with
 ```json
@@ -1672,6 +1928,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request to record a deployment** from Pact Broker Client, with
+```json
+{
+  "method": "POST",
+  "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "replacedPreviousDeployedVersion": true
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "replacedPreviousDeployedVersion": true
+  }
+}
+```
 <a name="a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_&#39;Pricing_Service&#39;_already_exists_in_the_pact-broker"></a>
 Given **the 'Pricing Service' already exists in the pact-broker**, upon receiving **a request to register the repository URL of a pacticipant** from Pact Broker Client, with
 ```json

data/lib/pact_broker/client.rb

@@ -1,2 +1,2 @@
 require 'pact_broker/client/version'
-require 'pact_broker/client/pact_broker_client'
+require 'pact_broker/client/pact_broker_client'

data/lib/pact_broker/client/backports.rb

@@ -0,0 +1,13 @@
+class Hash
+  def compact
+    h = {}
+    each do |key, value|
+      h[key] = value unless value == nil
+    end
+    h
+  end unless method_defined? :compact
+
+  def compact!
+    reject! {|_key, value| value == nil}
+  end unless method_defined? :compact!
+end

data/lib/pact_broker/client/cli/broker.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/cli/custom_thor'
+require 'pact_broker/client/hash_refinements'
 require 'thor/error'
 
 module PactBroker
@@ -11,6 +12,8 @@ module PactBroker
       class VersionCreationError < ::Thor::Error; end
 
       class Broker < CustomThor
+        using PactBroker::Client::HashRefinements
+
         desc 'can-i-deploy', ''
         long_desc File.read(File.join(File.dirname(__FILE__), 'can_i_deploy_long_desc.txt'))
 
@@ -18,16 +21,13 @@ module PactBroker
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
         method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
         method_option :to, required: false, banner: 'TAG', desc: "This is too hard to explain in a short sentence. Look at the examples.", default: nil
-        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
-        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+        method_option :to_environment, required: false, banner: 'ENVIRONMENT', desc: "The environment into which the pacticipant(s) are to be deployed", default: nil, hide: true
         method_option :output, aliases: "-o", desc: "json or table", default: 'table'
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
         method_option :retry_while_unknown, banner: 'TIMES', type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
         method_option :retry_interval, banner: 'SECONDS', type: :numeric, default: 10, required: false, desc: "The time between retries in seconds. Use in conjuction with --retry-while-unknown"
         # Allow limit to be set manually until https://github.com/pact-foundation/pact_broker-client/issues/53 is fixed
         method_option :limit, hide: true
+        shared_authentication_options
 
         def can_i_deploy(*ignored_but_necessary)
           require 'pact_broker/client/cli/version_selector_options_parser'
@@ -37,21 +37,20 @@ module PactBroker
           selectors = VersionSelectorOptionsParser.call(ARGV)
           validate_can_i_deploy_selectors(selectors)
           can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval }
-          result = CanIDeploy.call(options.broker_base_url, selectors, {to_tag: options.to, limit: options.limit}, can_i_deploy_options, pact_broker_client_options)
+          result = CanIDeploy.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit }, can_i_deploy_options, pact_broker_client_options)
           $stdout.puts result.message
-          exit(1) unless result.success
+          exit(can_i_deploy_exit_status) unless result.success
         end
 
         desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
         method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
-        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
-        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+        method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
+        method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
+        method_option :build_url, desc: "The build URL that created the pact"
         method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        shared_authentication_options
 
         def publish(*pact_files)
           require 'pact_broker/client/error'
@@ -69,11 +68,7 @@ module PactBroker
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
         method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
-        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
-        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        shared_authentication_options
 
         def create_version_tag
           require 'pact_broker/client/create_tag'
@@ -93,12 +88,8 @@ module PactBroker
         method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version number."
         method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Describe the latest pacticipant version. Optionally specify a TAG to describe the latest version with the specified tag."
-        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
-        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
         method_option :output, aliases: "-o", desc: "json or table or id", default: 'table'
-        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+        shared_authentication_options
 
         desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
         def describe_version
@@ -139,7 +130,7 @@ module PactBroker
 
         desc 'test-webhook', 'Test the execution of a webhook'
         method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         def test_webhook
           require 'pact_broker/client/webhooks/test'
           result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
@@ -157,7 +148,7 @@ module PactBroker
         desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
         method_option :name, type: :string, required: true, desc: "Pacticipant name"
         method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         verbose_option
         def create_or_update_pacticipant(*required_but_ignored)
           raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.name.strip.size == 0
@@ -168,7 +159,7 @@ module PactBroker
         end
 
         desc 'list-latest-pact-versions', 'List the latest pact for each integration'
-        shared_authentication_options_for_pact_broker
+        shared_authentication_options
         method_option :output, aliases: "-o", desc: "json or table", default: 'table'
         def list_latest_pact_versions(*required_but_ignored)
           require 'pact_broker/client/pacts/list_latest_versions'
@@ -177,6 +168,62 @@ module PactBroker
           exit(1) unless result.success
         end
 
+        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
+
+          ignored_and_hidden_potential_options_from_environment_variables
+          desc "record-deployment", "Record deployment of a pacticipant version to an environment"
+          method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
+          method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
+          method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
+          method_option :replaced_previous_deployed_version, type: :boolean, default: true, required: false, desc: "Whether or not this deployment replaced the previous deployed version. If it did, the previous deployed version of this pacticipant will be marked as undeployed in the Pact Broker."
+          method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+          shared_authentication_options
+
+          def record_deployment
+            require 'pact_broker/client/versions/record_deployment'
+            params = {
+              pacticipant_name: options.pacticipant,
+              version_number: options.version,
+              environment_name: options.environment,
+              replaced_previous_deployed_version: options.replaced_previous_deployed_version,
+              output: options.output
+            }
+            result = PactBroker::Client::Versions::RecordDeployment.call(
+              params,
+              options.broker_base_url,
+              pact_broker_client_options
+            )
+            $stdout.puts result.message
+            exit(1) unless result.success
+          end
+
+          ignored_and_hidden_potential_options_from_environment_variables
+          desc "record-undeployment", "Record undeployment of (or the end of support for) a pacticipant version from an environment"
+          method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
+          method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
+          method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
+          method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+          shared_authentication_options
+
+          def record_undeployment
+            require 'pact_broker/client/versions/record_undeployment'
+            params = {
+              pacticipant_name: options.pacticipant,
+              version_number: options.version,
+              environment_name: options.environment,
+              output: options.output
+            }
+            result = PactBroker::Client::Versions::RecordUndeployment.call(
+              params,
+              options.broker_base_url,
+              pact_broker_client_options
+            )
+            $stdout.puts result.message
+            exit(1) unless result.success
+          end
+
+        end
+
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'version', "Show the pact_broker-client gem version"
         def version
@@ -191,6 +238,16 @@ module PactBroker
             true
           end
 
+          def can_i_deploy_exit_status
+            exit_code_string = ENV.fetch('PACT_BROKER_CAN_I_DEPLOY_EXIT_CODE_BETA', '')
+            if exit_code_string =~ /^\d+$/
+              $stderr.puts "Exiting can-i-deploy with configured exit code #{exit_code_string}"
+              exit_code_string.to_i
+            else
+              1
+            end
+          end
+
           def validate_credentials
             if options.broker_username && options.broker_token
               raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
@@ -210,13 +267,20 @@ module PactBroker
 
           def publish_pacts pact_files
             require 'pact_broker/client/publish_pacts'
+
             write_options = options[:merge] ? { write: :merge } : {}
+            consumer_version_params = {
+              number: options.consumer_app_version,
+              branch: branch,
+              tags: tags,
+              build_url: options.build_url,
+              version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+            }.compact
 
             PactBroker::Client::PublishPacts.call(
               options.broker_base_url,
               file_list(pact_files),
-              options.consumer_app_version,
-              tags,
+              consumer_version_params,
               pact_broker_client_options.merge(write_options)
             )
           end
@@ -238,21 +302,35 @@ module PactBroker
             require 'pact_broker/client/git'
 
             t = [*options.tag]
-            t << PactBroker::Client::Git.branch if options.tag_with_git_branch
+            t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
             t.compact.uniq
           end
 
+          def branch
+            require 'pact_broker/client/git'
+
+            if options.branch.nil? && options.auto_detect_version_properties
+              PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
+            else
+              options.branch
+            end
+          end
+
+          def explict_auto_detect_version_properties
+            @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+          end
+
           def pact_broker_client_options
             client_options = { verbose: options.verbose }
-            client_options[:token] =  options.broker_token if options.broker_token
-            if options.broker_username
+            client_options[:token] = options.broker_token || ENV['PACT_BROKER_TOKEN']
+            if options.broker_username || ENV['PACT_BROKER_USERNAME']
               client_options[:basic_auth] = {
-                  username: options.broker_username,
-                  password: options.broker_password
-                }
+                  username: options.broker_username || ENV['PACT_BROKER_USERNAME'],
+                  password: options.broker_password || ENV['PACT_BROKER_PASSWORD']
+                }.compact
             end
 
-            client_options
+            client_options.compact
           end
 
           def parse_webhook_events