pact_broker-client 1.70.0 → 1.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39e09b6dd262ec6baa6da53747ac6adfcac1b83e87050973d10624d6d0dbc85
-  data.tar.gz: 817e36de371bb43762e42c8103735f291a1645a782541581cbff501a70b309da
+  metadata.gz: 7cab4d53c9ef3be0be8a1bdd732c4e7eefddad4e2bd27591ca06500e5c63a81d
+  data.tar.gz: 67e2015656535cf37325f9a45d7fca195c1a2fb64e157e6a1485447d76173551
 SHA512:
-  metadata.gz: 68d61e0fef6e96bd4acce08bc781aee2895b209cecbb0e3f453fe8e7e3843f417e5f3f62604dfda8ed5bee803c382c49eb552d17cc5fe06101fcab9848e1e34e
-  data.tar.gz: bf36dbe78ff7fdd10af8983be7130928389175c8b6770ee1772f9a31ccac6920d6316890850d33d8c179a8e9ce3dd1467338810e2879dd71079c751bc2e117a4
+  metadata.gz: d70c00647a761e2cf37028514027b4a36ae0159a65145949144cdc2e3026dfdcaef93d3ac8a827bf1ad43e55e0cf8e7dc40a5ad1117e4424fe70054b153334e9
+  data.tar.gz: 88264d74be62413f138453b54a842eab64b975d3a5f433ffd370993f86afe4ebd2bb79f969f92c3b54b6ac51a641b729515224996d3c154d721e036cdc8d7448

data/.github/workflows/test.yml

@@ -30,12 +30,15 @@ jobs:
         with:
           ruby-version: "3.2"
       - run: "bundle install"
+      # Publish to old and new account until we can disable the old account
       - run: |
           rm -rf spec/pacts/*
           bundle exec rspec spec/service_providers/
-          VERBOSE=true bundle exec rake pact:publish:pactflow
+          VERBOSE=true bundle exec rake pact:publish:pactflow_oss
+          VERBOSE=true bundle exec rake pact:publish:pactflow_pact_foundation
         env:
           PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
+          PACT_BROKER_TOKEN_PACT_FOUNDATION: ${{ secrets.PACT_BROKER_TOKEN_PACT_FOUNDATION }}
           PACT_BROKER_FEATURES: ${{ matrix.feature }}
           TEST_FEATURE: ${{ matrix.feature }}
   can-i-deploy:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="v1.71.0"></a>
+### v1.71.0 (2023-09-07)
+
+#### Features
+
+* publish provider contracts using all in one endpoint (#141)	 ([a9f87a8](/../../commit/a9f87a8))
+
 <a name="v1.70.0"></a>
 ### v1.70.0 (2023-08-29)
 

data/README.md

@@ -434,7 +434,7 @@ Options:
   -e, [--version=VERSION]
               # The pacticipant version. Must be entered after the
                 --pacticipant that it relates to.
-      [--ignore=IGNORE]
+      [--ignore=PACTICIPANT]
               # The pacticipant name to ignore. Use once for each pacticipant
                 being ignored. A specific version can be ignored by also
                 specifying a --version after the pacticipant name option. The
@@ -458,10 +458,6 @@ Options:
               # The tag that represents the branch or environment of the
                 integrated applications for which you want to check the
                 verification result status.
-      [--ignore=IGNORE]
-              # The pacticipant name to ignore. Use once for each pacticipant
-                being ignored. A specific version can be ignored by also
-                specifying a --version after the pacticipant name option.
   -o, [--output=OUTPUT]
               # json or table
               # Default: table
@@ -505,8 +501,8 @@ Description:
   support for environments, deployments and releases. For documentation on how to use can-i-deploy with tags, please see
   https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
 
-  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The "test"
-  and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
+  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The
+  "test" and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
   https://docs.pact.io/pact_broker/client_cli/readme#environments for more information.
 
   $ pact-broker create-environment --name "uat" --display-name "UAT" --no-production
@@ -516,8 +512,8 @@ Description:
 
   $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment uat
 
-  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy with
-  the versions of each integrated application that are already in that environment.
+  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy
+  with the versions of each integrated application that are already in that environment.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
 
@@ -525,8 +521,8 @@ Description:
 
   $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
 
-  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the latest version
-  from the main branch of another application" it functions as a "can I merge" check.
+  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the
+  latest version from the main branch of another application" it functions as a "can I merge" check.
 
   $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
 
@@ -536,6 +532,56 @@ If the verification process takes a long time and there are results missing when
 command to poll and wait for the missing results to arrive. The arguments to specify are `--retry-while-unknown TIMES` and `--retry-interval SECONDS`, set to
 appropriate values for your pipeline.
 
+#### can-i-merge
+
+```
+Usage:
+  pact-broker can-i-merge -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --pacticipant=PACTICIPANT
+              # The pacticipant name. Use once for each pacticipant being
+                checked.
+  -e, [--version=VERSION]
+              # The pacticipant version. Must be entered after the
+                --pacticipant that it relates to.
+  -o, [--output=OUTPUT]
+              # json or table
+              # Default: table
+      [--retry-while-unknown=TIMES]
+              # The number of times to retry while there is an unknown
+                verification result (ie. the provider verification is likely
+                still running)
+              # Default: 0
+      [--retry-interval=SECONDS]
+              # The time between retries in seconds. Use in conjuction with
+                --retry-while-unknown
+              # Default: 10
+      [--dry-run], [--no-dry-run]
+              # When dry-run is enabled, always exit process with a success
+                code. Can also be enabled by setting the environment variable
+                PACT_BROKER_CAN_I_MERGE_DRY_RUN=true. This mode is useful when
+                setting up your CI/CD pipeline for the first time, or in a
+                'break glass' situation where you need to knowingly deploy what
+                Pact considers a breaking change. For the second scenario, it
+                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.
+  -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
+```
+
+Description:
+  Checks if the specified pacticipant version is compatible with the configured main branch of each of the pacticipants with which it is integrated.
+
 ### Pacticipants
 
 #### create-or-update-pacticipant
@@ -679,8 +725,8 @@ Options:
 ```
 
 Description:
-  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,
-  provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
+  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, provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
 
   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
   option. Please use the --broker-username or environment variable for the Pact Broker username.
@@ -744,9 +790,9 @@ Options:
 ```
 
 Description:
-  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
-  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
-  also be provided. You can generate a valid UUID by using the `generate-uuid` command.
+  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 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 also be provided. You can generate a valid UUID by using the `generate-uuid` command.
 
   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
   option. Please use the --broker-username or environment variable for the Pact Broker username.
@@ -930,6 +976,8 @@ Options:
               # The tool used to verify the provider contract
       [--verifier-version=VERIFIER_VERSION]
               # The version of the tool used to verify the provider contract
+      [--build-url=BUILD_URL]
+              # The build URL that created the provider contract
   -o, [--output=OUTPUT]
               # json or text
               # Default: text

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

@@ -4,12 +4,16 @@
 
 * [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_pb:publish-provider-contract_relation_exists_in_the_index_resource) given the pb:publish-provider-contract relation exists in the index resource
+
 * [A request to create a provider contract](#a_request_to_create_a_provider_contract)
 
 * [A request to create a provider contract](#a_request_to_create_a_provider_contract_given_there_is_a_pf:ui_href_in_the_response) given there is a pf:ui href in the response
 
 * [A request to create a webhook for a team](#a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists) given a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists
 
+* [A request to publish a provider contract](#a_request_to_publish_a_provider_contract)
+
 #### Interactions
 
 <a name="a_request_for_the_index_resource"></a>
@@ -45,6 +49,33 @@ PactFlow will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:publish-provider-contract_relation_exists_in_the_index_resource"></a>
+Given **the pb:publish-provider-contract 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"
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pf:publish-provider-contract": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-{provider}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_create_a_provider_contract"></a>
 Upon receiving **a request to create a provider contract** from Pact Broker Client, with
 ```json
@@ -56,7 +87,7 @@ Upon receiving **a request to create a provider contract** from Pact Broker Clie
     "Accept": "application/hal+json"
   },
   "body": {
-    "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+    "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
     "contractType": "oas",
     "contentType": "application/yaml",
     "verificationResults": {
@@ -90,7 +121,7 @@ Given **there is a pf:ui href in the response**, upon receiving **a request to c
     "Accept": "application/hal+json"
   },
   "body": {
-    "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+    "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
     "contractType": "oas",
     "contentType": "application/yaml",
     "verificationResults": {
@@ -104,7 +135,7 @@ Given **there is a pf:ui href in the response**, upon receiving **a request to c
   }
 }
 ```
-Pactflow will respond with:
+PactFlow will respond with:
 ```json
 {
   "status": 201,
@@ -114,7 +145,7 @@ Pactflow will respond with:
   "body": {
     "_links": {
       "pf:ui": {
-        "href": "http://localhost:1235/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+        "href": "some-url"
       }
     }
   }
@@ -171,3 +202,66 @@ PactFlow will respond with:
   }
 }
 ```
+<a name="a_request_to_publish_a_provider_contract"></a>
+Upon receiving **a request to publish a provider contract** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-Bar",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "pacticipantVersionNumber": "1",
+    "tags": [
+      "dev"
+    ],
+    "branch": "main",
+    "buildUrl": "http://build",
+    "contract": {
+      "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+      "contentType": "application/yaml",
+      "specification": "oas",
+      "selfVerificationResults": {
+        "success": true,
+        "content": "c29tZSByZXN1bHRz",
+        "contentType": "text/plain",
+        "format": "text",
+        "verifier": "my custom tool",
+        "verifierVersion": "1.0"
+      }
+    }
+  }
+}
+```
+PactFlow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "notices": [
+      {
+        "text": "some notice",
+        "type": "info"
+      }
+    ],
+    "_embedded": {
+      "version": {
+        "number": "1"
+      }
+    },
+    "_links": {
+      "pb:pacticipant-version-tags": [
+        {
+        }
+      ],
+      "pb:branch-version": {
+      }
+    }
+  }
+}
+```

data/doc/pacts/markdown/README.md

@@ -1,4 +1,4 @@
 ### Pacts for Pact Broker Client
 
 * [Pact Broker](Pact%20Broker%20Client%20-%20Pact%20Broker.md)
-* [PactFlow](Pact%20Broker%20Client%20-%20Pactflow.md)
+* [PactFlow](Pact%20Broker%20Client%20-%20PactFlow.md)

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

@@ -13,13 +13,12 @@ module PactBroker
 
             method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
             method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
-            method_option :ignore, required: false, desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option. The environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE may also be used to specify a pacticipant name to ignore, with commas to separate multiple pacticipant names if necessary."
+            method_option :ignore, required: false, banner: "PACTICIPANT", desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option. The environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE may also be used to specify a pacticipant name to ignore, with commas to separate multiple pacticipant names if necessary."
             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 :branch, required: false, desc: "The branch of the version for which you want to check the verification results.", default: nil
             method_option :main_branch, required: false, type: :boolean, desc: "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
             method_option :to_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil
             method_option :to, required: false, banner: "TAG", desc: "The tag that represents the branch or environment of the integrated applications for which you want to check the verification result status.", default: nil
-            method_option :ignore, required: false, desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option."
             method_option :output, aliases: "-o", desc: "json or table", default: "table"
             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"

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.70.0'
+    VERSION = '1.71.0'
   end
 end

data/lib/pactflow/client/cli/provider_contract_commands.rb

@@ -26,7 +26,7 @@ module Pactflow
             method_option :verification_results_format, desc: "The format of the verification output eg. junit, text"
             method_option :verifier, desc: "The tool used to verify the provider contract"
             method_option :verifier_version, desc: "The version of the tool used to verify the provider contract"
-            #method_option :build_url, desc: "The build URL that created the pact"
+            method_option :build_url, desc: "The build URL that created the provider contract"
 
             output_option_json_or_text
             shared_authentication_options
@@ -70,6 +70,7 @@ module Pactflow
                   provider_version_number: options.provider_app_version.strip,
                   branch_name: options.branch && options.branch.strip,
                   tags: (options.tag && options.tag.collect(&:strip)) || [],
+                  build_url: options.build_url,
                   contract: {
                     content: File.read(provider_contract_path),
                     content_type: options.content_type,

data/lib/pactflow/client/provider_contracts/publish.rb

@@ -1,13 +1,14 @@
-require "pact_broker/client/base_command"
-require "pact_broker/client/versions/create"
-require 'pact_broker/client/colorize_notices'
 require "base64"
+require "pact_broker/client/base_command"
+require "pact_broker/client/colorize_notices"
+require "pactflow/client/provider_contracts/publish_the_old_way"
 
 module Pactflow
   module Client
     module ProviderContracts
       class Publish < PactBroker::Client::BaseCommand
-        attr_reader :branch_name, :tags, :provider_name, :provider_version_number, :contract, :verification_results
+        PUBLISH_RELATION = "pf:publish-provider-contract"
+
 
         def initialize(params, options, pact_broker_client_options)
           super
@@ -15,62 +16,30 @@ module Pactflow
           @provider_version_number = params[:provider_version_number]
           @branch_name = params[:branch_name]
           @tags = params[:tags] || []
+          @build_url = params[:build_url]
           @contract = params[:contract]
           @verification_results = params[:verification_results]
         end
 
         private
 
-        def do_call
-          create_branch_version_and_tags
-          render_response(create_contract)
-        end
+        attr_reader :provider_name, :provider_version_number, :branch_name, :tags, :build_url, :contract, :verification_results
 
-        def render_response(res)
-          notices = [
-            { type: 'success', text: "Successfully published provider contract for #{provider_name} version #{provider_version_number} to PactFlow"},
-          ]
-          if res.body && res.body['_links'] && res.body['_links']['pf:ui']['href']
-            notices.concat([{ text: "View the uploaded contract at #{res.body['_links']['pf:ui']['href']}" }])
+        def do_call
+          if enabled? && index_resource.assert_success!.can?(PUBLISH_RELATION)
+            publish_provider_contracts
+            PactBroker::Client::CommandResult.new(success?, message)
+          else
+            PublishTheOldWay.call(params, options, pact_broker_client_options)
           end
-          notices.concat(next_steps)
-          PactBroker::Client::CommandResult.new(true, PactBroker::Client::ColorizeNotices.call(notices.collect do |n|
-                                                                                                 OpenStruct.new(n)
-                                                                                               end).join("\n"))
-        end
-
-        def next_steps
-          [
-            { type: 'prompt', text: 'Next steps:' },
-            { type: 'prompt',
-              text: '  * Check your application is safe to deploy - https://docs.pact.io/can_i_deploy' },
-            { text: "       pact-broker can-i-deploy --pacticipant #{provider_name} --version #{provider_version_number} --to-environment <your environment name>" },
-            { type: 'prompt',
-              text: '  * Record deployment or release to specified environment (choose one) - https://docs.pact.io/go/record-deployment' },
-            { text: "       pact-broker record-deployment --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" },
-            { text: "       pact-broker record-release --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" }
-          ]
         end
 
-        def create_branch_version_and_tags
-          if branch_name || tags.any?
-            pacticipant_version_params = {
-              pacticipant_name: provider_name,
-              version_number: provider_version_number,
-              branch_name: branch_name,
-              tags: tags
-            }
-            result = PactBroker::Client::Versions::Create.call(pacticipant_version_params, options, pact_broker_client_options)
-            if !result.success
-              raise PactBroker::Client::Error.new(result.message)
-            end
-          end
+        def enabled?
+          ENV.fetch("PACT_BROKER_FEATURES", "").include?("publish_provider_contracts_all_in_one")
         end
 
-        def create_contract
-          contract_path = "#{pact_broker_base_url}/contracts/provider/{provider}/version/{version}"
-          entrypoint = create_entry_point(contract_path, pact_broker_client_options)
-          entrypoint.expand(provider: provider_name, version: provider_version_number).put!(contract_params).response
+        def publish_provider_contracts
+          @response_entity = index_resource._link(PUBLISH_RELATION).expand(provider: provider_name).post!(contract_params, headers: { "Accept" => "application/hal+json,application/problem+json" })
         end
 
         def contract_params
@@ -82,22 +51,45 @@ module Pactflow
                                           verifier: verification_results[:verifier],
                                           verifierVersion: verification_results[:verifier_version]
                                         }.compact
-                                        
-          body_params = {
-                          content: encode_content(contract[:content]),
-                          contractType: contract[:specification],
-                          contentType: contract[:content_type],
-                        }.compact
+
+          contract_params = {
+                              content: encode_content(contract[:content]),
+                              specification: contract[:specification],
+                              contentType: contract[:content_type]
+                            }.compact
 
           if verification_results_params.any?
-            body_params[:verificationResults] = verification_results_params
+            contract_params[:selfVerificationResults] = verification_results_params
           end
-          body_params
+
+          {
+            pacticipantVersionNumber: provider_version_number,
+            tags: tags,
+            branch: branch_name,
+            buildUrl: build_url,
+            contract: contract_params
+          }
         end
 
         def encode_content oas
           Base64.strict_encode64(oas)
         end
+
+        def message
+          if options[:output] == "json"
+            @response_entity.response.raw_body
+          else
+            text_message
+          end
+        end
+
+        def success?
+          @response_entity.success?
+        end
+
+        def text_message
+          PactBroker::Client::ColorizeNotices.call(@response_entity.notices.collect{ |n| OpenStruct.new(n) } )
+        end
       end
     end
   end

data/lib/pactflow/client/provider_contracts/publish_the_old_way.rb

@@ -0,0 +1,104 @@
+require "pact_broker/client/base_command"
+require "pact_broker/client/versions/create"
+require 'pact_broker/client/colorize_notices'
+require "base64"
+
+module Pactflow
+  module Client
+    module ProviderContracts
+      class PublishTheOldWay < PactBroker::Client::BaseCommand
+        attr_reader :branch_name, :tags, :provider_name, :provider_version_number, :contract, :verification_results
+
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @provider_name = params[:provider_name]
+          @provider_version_number = params[:provider_version_number]
+          @branch_name = params[:branch_name]
+          @tags = params[:tags] || []
+          @contract = params[:contract]
+          @verification_results = params[:verification_results]
+        end
+
+        private
+
+        def do_call
+          create_branch_version_and_tags
+          render_response(create_contract)
+        end
+
+        def render_response(res)
+          notices = [
+            { type: 'success', text: "Successfully published provider contract for #{provider_name} version #{provider_version_number} to PactFlow"},
+          ]
+          if res.body && res.body['_links'] && res.body['_links']['pf:ui']['href']
+            notices.concat([{ text: "View the uploaded contract at #{res.body['_links']['pf:ui']['href']}" }])
+          end
+          notices.concat(next_steps)
+          PactBroker::Client::CommandResult.new(true, PactBroker::Client::ColorizeNotices.call(notices.collect do |n|
+                                                                                                 OpenStruct.new(n)
+                                                                                               end).join("\n"))
+        end
+
+        def next_steps
+          [
+            { type: 'prompt', text: 'Next steps:' },
+            { type: 'prompt',
+              text: '  * Check your application is safe to deploy - https://docs.pact.io/can_i_deploy' },
+            { text: "       pact-broker can-i-deploy --pacticipant #{provider_name} --version #{provider_version_number} --to-environment <your environment name>" },
+            { type: 'prompt',
+              text: '  * Record deployment or release to specified environment (choose one) - https://docs.pact.io/go/record-deployment' },
+            { text: "       pact-broker record-deployment --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" },
+            { text: "       pact-broker record-release --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" }
+          ]
+        end
+
+        def create_branch_version_and_tags
+          if branch_name || tags.any?
+            pacticipant_version_params = {
+              pacticipant_name: provider_name,
+              version_number: provider_version_number,
+              branch_name: branch_name,
+              tags: tags
+            }
+            result = PactBroker::Client::Versions::Create.call(pacticipant_version_params, options, pact_broker_client_options)
+            if !result.success
+              raise PactBroker::Client::Error.new(result.message)
+            end
+          end
+        end
+
+        def create_contract
+          contract_path = "#{pact_broker_base_url}/contracts/provider/{provider}/version/{version}"
+          entrypoint = create_entry_point(contract_path, pact_broker_client_options)
+          entrypoint.expand(provider: provider_name, version: provider_version_number).put!(contract_params).response
+        end
+
+        def contract_params
+          verification_results_params = {
+                                          success: verification_results[:success],
+                                          content:  verification_results[:content] ? encode_content(verification_results[:content]) : nil,
+                                          contentType: verification_results[:content_type],
+                                          format: verification_results[:format],
+                                          verifier: verification_results[:verifier],
+                                          verifierVersion: verification_results[:verifier_version]
+                                        }.compact
+                                        
+          body_params = {
+                          content: encode_content(contract[:content]),
+                          contractType: contract[:specification],
+                          contentType: contract[:content_type],
+                        }.compact
+
+          if verification_results_params.any?
+            body_params[:verificationResults] = verification_results_params
+          end
+          body_params
+        end
+
+        def encode_content oas
+          Base64.strict_encode64(oas)
+        end
+      end
+    end
+  end
+end