Changelog

### v1.77.0 (2024-10-08)

Features

• support --ignore flag in can-i-merge command (1349bd0)

### v1.76.2 (2024-10-13)

Bug Fixes

• Add dependency of ostruct to gem, to fix warning ostruct was loaded (eb61c27)
• Dockerfile to reduce vulnerabilities (#172) (79482c2)

### v1.76.1 (2024-08-21)

Bug Fixes

• missing list_latest_versions due to loose regex on gem files (#170) (c5776fc)

### v1.76.0 (2024-08-07)

Features

• can-i-deploy
  • skip --retry-while-unknown if --dry-run true (cbbcc0a)

### v1.75.4 (2024-07-30)

Bug Fixes

• remove test files from built gem (4bb7bac)

### v1.75.3 (2024-06-17)### v1.75.2 (2024-05-13)

Bug Fixes

• explicitly require openstruct (fdb70cf)

### v1.75.1 (2023-11-23)

Bug Fixes

• verification-required command invalid arg number (fa3b1ca)

### v1.75.0 (2023-11-11)

Features

• add support for delete-branch command (#151) (6da6202)

Bug Fixes

• set correct Accept header when publishing provider contracts (abc8ea3)

### v1.74.0 (2023-10-14)

Features

• auto detect commit sha, add shorthand -r flag (#119) (1dac9f8)

Bug Fixes

• support merging v3 pacts (d1e01d0)

### v1.73.0 (2023-10-13)

Features

• print warnings and allow error to be raised when unknown option is used (5412121)
• raise an error when an em dash is used instead of a normal dash (0e8e773)
• support --help and -h flags (a6458ab)
• handle x509 certs in HTTP Client (#142) (c3aa8dc)

### v1.72.0 (2023-09-11)

Features

• enable publishing provider contracts using the 'all in one' endpoint (398d58c)

### v1.71.0 (2023-09-07)

Features

• publish provider contracts using all in one endpoint (#141) (a9f87a8)

### v1.70.0 (2023-08-29)

Features

• sort can-i-deploy table by consumer name, then provider name (83412e7)
• do not accept gzip responses when VERBOSE=true (a72a529)

### v1.69.0 (2023-08-29)

Features

• can-i-merge (#117) (badb030)

### v1.68.0 (2023-07-08)

Features

• support Cirrus CI environment (7610f28)

Bug Fixes

• pact-broker --help command failed with Could not find command "__broker_base_url" (#135) (7edfd58)

### v1.67.0 (2023-05-04)

Features

• colour first url in magenta for ease of reading (90e8f51)
• output provider contract link on publish (#118) (132b024)
• add helper text for Docker usage when pact file not found (2aab2d5)

Bug Fixes

• trim trailing slash from base url (ccd6417)
• do not allow an empty environment name to be used in the can-i-deploy command (a3bfe8a)

### v1.66.1 (2023-01-11)

Bug Fixes

• deps
  • update httparty for https://github.com/jnunemaker/httparty/security/advisories/GHSA-5pq7-52mg-hr42 (08597c2)

### v1.66.0 (2022-12-01)

Features

• can-i-deploy

  • support specifying --ignore using the environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE (04a0894)

• refactor can-i-deploy to use HAL Client instead of HTTParty (d21efe6)

Bug Fixes

• found the missing computer arm when computer says no (#120) (7b8ea24)

• publish-provider-contract

  • raise validation error when pact broker base URL is missing or blank (2d719c3)

### v1.65.0 (2022-06-24)

Features

• add support for automatically detecting the git commit and branch for Azure DevOps (889f83f)

### v1.64.0 (2022-05-27)

Features

• remove feature flag for publish-provider-contract (146a2d8)
• add pactflow specific message for environment not found when recording a release/deployment (6667cbb)

### v1.63.0 (2022-05-10)

Features

• add --verification-exit-code to publish-provider-contract command (d35d908)

### v1.62.1 (2022-05-10)

Bug Fixes

• set exit on failure to true for new pactflow command (429dfbd)

### v1.62.0 (2022-05-10)

Features

• add command to publish provider contracts to pactflow (feature toggle required) (#107) (80cc10e)

Bug Fixes

• use ruby < 2.3 syntax. (#108) (20f1e01)

### v1.61.1 (2022-05-09)

Bug Fixes

• Aushm use ruby 2.2 syntax (#110) (b006ad7)

### v1.61.0 (2022-05-06)

Features

• create-or-update-version
  • support creating or updating a pacticipant version with a branch and/or tags (e38e728)

### v1.60.0 (2022-05-03)

Features

• support merging message pacts when publishing (732b22d)

### v1.59.0 (2022-03-11)

Features

• use the feature branch name in GITHUB_HEAD_REF for github pull request builds (#103) (7f94d4a)

• webhooks

  • show better error message when the pb:webhooks relation doesn't exist when trying to create a webhook (c787300)

### v1.58.0 (2021-11-13)

Features

• remove feature toggle for creating contract_requiring_verification_published webhooks (6eff6d1)

### v1.57.0 (2021-11-05)

Features

• support the --branch option in the version selectors for can-i-deploy (dba8ec4)
• show more helpful error message if pb:environments not available for pactflow (1bf38e3)
• print out notices if returned from publish pacts request (86caf7e)

### v1.56.0 (2021-10-06)

Features

• add pacticipant label options to webhook create/update commands (#96) (710293f)

### v1.55.0 (2021-10-03)

Features

• support Github Actions environment variables for --tag-with-git-branch (2b8dac5)

### v1.54.0 (2021-10-01)

Features

• disable SSL verification for HAL client and HTTParty client when environment variable PACT_DISABLE_SSL_VERIFICATION=true (470aafa)
• support setting the --main-branch for a pacticipant (1f18e70)

### v1.53.0 (2021-09-29)

Features

• allow pacts to be published using the old API by setting the environment variable PACT_BROKER_FEATURES=publish_pacts_using_old_api (7c34132)

### v1.52.0 (2021-09-29)

Features

• rename target to application-instance for record-deployment and record-undeployment (backwards compatible) (53d23eb)

### v1.51.2 (2021-09-27)

Bug Fixes

• deps
  • lock httparty to 0.18.1 (1ab2d9c)

### v1.51.1 (2021-09-22)

Bug Fixes

• remove deprecated method of handling branches (6d26487)

### v1.51.0 (2021-09-22)

Features

• enable use of the new 'all in one' contracts publishing endpoint without a feature toggle (6850ace)

### v1.50.0 (2021-08-16)

Features

• add support for creating webhooks with event contract_requiring_verification_published (feature toggled off) (4d4bc4b)
• trim long versions on can-i-deploy formatting (#91) (86d21e1)

### v1.49.0 (2021-08-05)

Features

• can-i-deploy
  • actually remove feature toggle for --ignore option (1c686f2)

### v1.48.0 (2021-08-04)

Features

• can-i-deploy
  • remove feature toggle for --ignore option (6e7edd8)

### v1.47.1 (2021-07-20)

Bug Fixes

• verification-required
  • require a verification when either of the specified versions does not exist (031d232)

### v1.47.0 (2021-07-09)

Features

• enabled deployment, release and environment commands without a feature toggle (bd64caa)
• update relations used for currently deploy/currently supported versions (6f6ca2f)

### v1.46.0 (2021-06-24)

Features

• support specifying team UUID when creating a webhook in PactFlow (c4201e1)

### v1.45.0 (2021-06-16)

Features

• can-i-deploy

  • allow dry-run to be enabled by setting ACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true (0562436)
  • add --dry-run option (9d90c79)

• add record-support-ended (feature toggled off) (8f6b593)

• update record-undeployment (feature toggled off) (0c0dd15)

• update record-undeployment (feature toggled off) (93046d5)

### v1.44.0 (2021-06-09)

Features

• add record-undeployment (feature toggled off) (951d334)
• add describe-environment command (cd11ebb)
• add record-release (feature toggled off) (e32e4e5)

Bug Fixes

• hardcode file requires Fixes: https://github.com/pact-foundation/pact_broker-client/issues/88 (581f2fd)

### v1.43.0 (2021-06-03)

Features

• enable --ignore option for can-i-deploy without a feature toggle (bcc9dfe)

### v1.42.0 (2021-05-31)

Features

• add list-pacticipants (fc8ce3b)
• add --display-name to create-or-update-pacticipant (76f323b)
• add backtrace to error output when verbose is true (abf1ef0)
• add list-environments and describe-environment (4472d48)
• add delete-environment (361eed1)
• add update-environment command (95276cd)
• add create-environment command (a9fab50)

Bug Fixes

• stop long values in columns from being truncated (18063fd)

### v1.41.0 (2021-05-25)

Features

• update colours of pact publish output (2a51e37)

### v1.40.0 (2021-04-26)

Features

• use the pb:publish-contracts relation and endpoint to publish pacts (19f1b0b)
• update publish pacts command to use new 'all in one' contract publishing endpoint (50dfb11)

### v1.39.0 (2021-04-27)

Features

• publish pacts using the "all in one" endpoint (#86) (3a1ea22)
• provide a more helpful error message when the specified pact file does not exist (29a7962)

### v1.38.3 (2021-04-08)

Bug Fixes

• URL encode parameters for HAL templated URLs (764a0fa)

### v1.38.2 (2021-04-01)

Features

• allow SSL verification to be disabled (eb2125b)
• automatically retry at the http client level for 50x responses (a7343f8)

### v1.38.1 (2021-03-22)### v1.38.0 (2021-03-22)### 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)

### v1.37.0 (2021-03-01)

Features

• add record-deployment (6e5e208)

Bug Fixes

• use refinement to add compact to Hash (c2c1cab)

### v1.36.0 (2021-02-21)

Features

• can-i-deploy

  • add --to-environment option (05ae44c)

• support version branch and build URL when publishing pacts (a75f7df)

### v1.35.0 (2021-01-21)

Features

• can-i-deploy
  • display links to verification results in the output of can-i-deploy when using text format (976950d)

### v1.34.0 (2020-11-20)

Features

• pact publish

  • strip new lines from version numbers and tags (5842d24)

• publish

  • update output text when pact already exists and merging (9b849d3)

### v1.33.0 (2020-11-10)

Features

• publish
  • allow pacts to be merged on the server side (bd80f10)

### v1.32.0 (2020-10-26)

Features

• Improve HTTP errors handling (#76) (d8eaf16)

Bug Fixes

• list-latest-pact-versions
  • correct json output (cf77666)

### v1.31.0 (2020-10-22)

Features

• update thor dependancy (#75) (2078f31)

### v1.30.0 (2020-10-09)

Features

• remove outdated comment from pact publishing output (251b4df)

### v1.29.1 (2020-08-07)

Bug Fixes

• explicitly set the CA file and path from SSL_CERT_FILE and SSL_CERT_DIR for the pact-ruby-standalone (27a0fe6)

### v1.29.0 (2020-08-05)

Features

• print out helpful error message for 403 (5d5a18a)
• support publishing pacts for multiple consumers at the same time (573e97c)

### v1.28.4 (2020-07-31)

Bug Fixes

• add missing require for PactBroker::Client::Error (72eb796)

### v1.28.3 (2020-07-19)### v1.28.2 (2020-07-17)

Bug Fixes

• create-version-tag
  • raise an error if the version does not exist rather than automatically creating it. (2ed7a55)

### v1.28.0 (2020-07-12)

Features

• deps
  • this isn't really a feature, but I want to test the release workflow (29a7b72)

Bug Fixes

• give the release docker image the secrets.GITHUB_TOKEN (c94a435)
• not really a fix, just testing release notes (78a919d)
• not really a fix, just testing release notes (13ddd06)
• testing release notes (1f38fdd)
• not a real fix, just testing release notes (1fabb8b)

### v1.27.0 (2020-05-09)

Features

• add BITBUCKET_BRANCH to list of known branch variables (#69) (d1dc088)
• add list-latest-pact-versions command (ed45d58)

### v1.26.0 (2020-04-17)

Features

• update message when waiting for verification results (68df012)

• add create-or-update-pacticipant (f1c33ae)

• can i deploy

  • put out a message while waiting for verification results to be published (cc1ba5f)

• publish pacts

  • improve message when overwriting pacts (17b93f3)

• webhooks

  • add command to test webhook execution (0ee1f7a)

### v1.25.1 (2020-04-02)

Features

• create-or-update-webhook
  • print 'created' or 'updated' based on response status (0c34090)

Bug Fixes

• incorrect require path for hal entity (64f3b7b)
• correctly handle multiple parameters specified in the format --name=value (946001b)

### v1.25.0 (2020-02-18)

Features

• cli
  • print any response body from the Pact Broker when authentication fails (116f0d9)
  • raise error if both basic auth credentials and bearer token are set (163f56b)

### v1.24.0 (2020-02-13)

Features

• create-webhook

  • support creating webhooks for contract_published, provider_verification_succeeded and provider_verification_failed events, and allow description to be set (b76f9c4)

• create-or-update-webhook

  • show helpful error message when attempting to create a webhook with a UUID on a version of the Pact Broker that doesn't support it (6e3d30f)

• cli

  • add generate-uuid command for use when using create-or-update-webhook (52824fb)
  • allow all versions for a particular tag to be specified when determining if it safe to deploy (mobile provider use case) (da54dc1)

• suppport equals sign in can-i-deploy pacticipant selector parameters (b5d89bc)

• use different git command to get git branch name (9373827)

• attempt to get git branch name from environment variable first before running git (d512ef0)

Bug Fixes

• can-i-deploy
  • if only one selector is specified and no --to TAG is specified, set latest=true for automatically calculated dependencies (045fa91)

### v1.23.0 (2020-01-21)

Features

• suppport equals sign in can-i-deploy pacticipant selector parameters (90f6457)

• cli

  • allow all versions for a particular tag to be specified when determining if it safe to deploy (mobile provider use case) (3690944)

### v1.22.1 (2020-01-16)

Features

• use different git command to get git branch name (70b1328)

### v1.21.0 (2020-01-16)

Features

• attempt to get git branch name from environment variable first before running git (122973b)

Bug Fixes

• can-i-deploy

  • if only one selector is specified and no --to TAG is specified, set latest=true for automatically calculated dependencies (ec10b72)

• remove -u alias for --broker-username for create-webhook as it clashes with the -u from the curl command (9463eff)

• Fix invalid environment variable names in can-i-deploy docs (2b26081)

### v1.20.0 (2019-08-27)

Features

• allow limit to be set for can-i-deploy until https://github.com/pact-foundation/pact_broker-client/issues/53 is fixed (f692774)

### v1.19.0 (2019-06-25)

Features

• hal client

  • update from pact-ruby (f8b3432)

• update pact with broker for scenario where version does not exist (27b744f)

Bug Fixes

• create webhook

  • pass in token from command line (9d3170e)

• correct pact merge error message (5ebe808)

### v1.18.0 (2019-03-05)

Features

• remove 'no data' message when there are no rows. (b0246a2)
• allow for broker token to be used (3266bc1)
• add broker token to cli (e342c29)

### v1.17.0 (2018-11-15)

Features

• update HAL client from pact codebase (ed77fe0)

### v1.16.0 (2018-07-09)

Features

• add retries to can-i-deploy to allow the command to wait for missing results to arrive (e44f88d)

### v1.15.1 (2018-06-28)

Bug Fixes

• declare dependency on rake in gemspec (b24bbcd)

### v1.15.0 (2018-06-22)

Features

• allow webhooks with optional consumer and provider to be created using the create-webhooks CLI (c6763b0)
• update expectation of error response (d45244f)
• add create-webhook to CLI (e1ec885)
• add title, name and title_or_name methods to Link (dc24caa)
• add http debug logging for create environment call (5f31fcb)
• add hal client (4d93bf9)
• update pacts relation name in retrieve pacts query (7d965bf)

Bug Fixes

• correctly escape expanded URL links (d6dbce8)
• correct accept headers for requests to the pact broker (415d9d5)

### v1.14.1 (2018-04-11)

Bug Fixes

• use SSL_CERT_FILE and SSL_CERT_DIR environment variables for https connections (e4e7a15)

### v1.14.0 (2018-01-25)

Features

• describe-version

  • allow retrieving latest pacticipant version (7679f61)

• update help text for can-i-deploy (7d3f3e1)

• add example showing how to use can-i-deploy and describe-version as a verification webhook endpoint (ec83387)

• cli

  • add describe-version (6e12478)
  • output HTTP request and response debugging when verbose mode enabled (f487714)

### v1.13.0 (2017-11-09)

Features

• can-i-deploy
  • allow pacticipant version to be checked against latest tagged versions of all the other pacticipants (7f10e13)

Bug Fixes

• publish
  • accept pact file paths using windows separator (5ee9dd7)

### v1.12.0 (2017-11-06)

Features

• publish

  • expose tag_with_git_branch in rake publication task (f28d9ad)

• can-i-deploy

  • shorten header names in text output (89d5a04)
  • support invocation with only one pacticipant/version provided (3d799cc)

### v1.11.0 (2017-11-01)

Features

• can-i-deploy

  • add --latest option to command line (c7f012d)

• allow broker base url, username and password to be set by environment variables (3516103)

• cli

  • add one line of backtrace to error output (c2ede03)

• create-version-tag

  • add CLI to tag a pacticipant version (c62d9b8)

### v1.10.0 (2017-10-31)

Features

• can-i-deploy
  • print out matrix summary 'reason' (aa25e16)

### v1.9.0 (2017-10-30)

Features

• cli

  • add option to --tag-with-git-branch when publishing pacts (484d5b8)

• can-i-deploy

  • raise error when no --version is supplied for a --pacticipant (0f3bfea)
  • change --name to --pacticipant (d5d23bc)
  • include full response body in json output (216bfdc)
  • use array of query params for matrix (314e2e2)

• what-can-i-deploy

  • add success param to matrix query (40adb2e)

• handle hash of errors in response (fff32c2)

• change query params for matrix to use pacticipant[]=? and version[]=? (003e305)

Bug Fixes

• can-i-deploy
  • correct provider name in text output (bfd0882)

### v1.8.0 (2017-10-19)

Features

• renamed pact-publish command to pact-broker publish (ed7d23a)

Bug Fixes

• pact-publish
  • ensure process exits with a status 1 when error is raised (800f5cd)

### v1.7.0 (2017-10-19)

Features

• can-i-deploy

  • change cli to use --name and --version options instead of bespoke version selector format (15e8131)
  • puts output to stdout for both success and failure scenarios so that JSON output can be parsed by capturing stdout (6db595a)
  • remove dates from table output and add success status (5dc9484)
  • add --output option allowing table or json to be specified (57fa24e)

• changed name of verification date field (962b7d1)

• output table of verification results when present (9220703)

• add 'pact-broker can-i-deploy' executable (ca68c54)

### v1.6.0 (2017-10-01)

BREAKING CHANGES

• cli
  • change cli option names to match pact-provider-verifier (0682662)

### v1.5.0 (2017-09-28)

Features

• cli

  • add command line tool to publish pacts (d031b98)

• publish pacts

  • merge pact files with same consumer/provider before publishing (1c039a0)

### v1.4.0 (2017-09-07)

Features

• tagging
  • url escape tag names (8335978)
  • allow multiple tags to be specified for a version (5f862fe)

v1.3.0 (2017-07-03)

• 138a042 - feat(tag): Added tag to PublicationTask (Beth Skurrie, Mon Jul 3 11:45:24 2017 +1000)

1.2.0 (2016-11-23)

• 08e6025 - Fixed broken spec - expected hal+json (Bethany Skurrie, Wed Nov 23 09:20:39 2016 +1100)
• ec4b7d7 - Added Travis badge. (Beth Skurrie, Wed Nov 23 09:16:10 2016 +1100)
• ff133f2 - Adding appraisals and updating test matrix (Bethany Skurrie, Wed Nov 23 09:10:40 2016 +1100)
• e79eec6 - Add hal+json to list of accepted content types (Steve Pletcher, Wed Sep 21 10:27:20 2016 -0400)
• 314f059 - add the option to retrieve all the latest (tagged) pacts for a provider (Olga Vasylchenko, Mon Nov 21 15:01:09 2016 +0100)

1.1.0 (2016-08-19)

• b5ea1b3 - Add support for publishing pacts via patch request (Steve Pletcher, Fri Aug 5 11:16:18 2016 -0400)

1.0.3 (2016-06-27)

• 04bd518 - Clarify that pact_broker-client will only work with ruby >= 2.0 (Sergei Matheson, Mon Jun 27 11:17:57 2016 +1000)

1.0.2 (2016-06-20)

• 4637978 - Warn on overwritting (Taiki Ono, Mon Jun 6 14:50:37 2016 +0900)

1.0.1 (2016-04-29)

• 72c099b - Add release instructions (Sergei Matheson, Fri Apr 29 11:54:01 2016 +1000)
• 12f0054 - :headers is duplicated and overwritten (Taiki Ono, Tue Mar 15 21:46:23 2016 +0900)
• e9251f7 - Commit pact files (Taiki Ono, Tue Mar 15 21:30:15 2016 +0900)
• 0278731 - Loosen content type header expectation (Taiki Ono, Tue Mar 15 21:26:03 2016 +0900)
• fff1838 - Remove Gemfile.lock and do not check-in (Taiki Ono, Sun Mar 13 21:49:36 2016 +0900)
• 48c1434 - Add Travis CI setting not to test with ruby1.9 (Taiki Ono, Sun Mar 13 21:17:11 2016 +0900)
• 0365b94 - Updated to RSpec 3 syntax (Beth, Mon Oct 19 08:54:48 2015 +1100)

1.0.0 (2014-10-09)

• 2c08da2 - added pact_broker_basic_auth options to publish task (lifei zhou, Fri Feb 27 21:33:09 2015 +1100)
• 1b84a54 - Updated pact-version rel name (Beth, Mon Dec 22 11:30:57 2014 +1100)
• 04c1e4e - Updated link rels (Beth, Thu Dec 11 14:32:27 2014 +1100)
• d1b2cad - Correcting pact publish message (Beth Skurrie, Mon Aug 25 07:15:57 2014 +1000)
• 6b1d147 - Added backwards compatibility for pact broker publish response (Beth Skurrie, Sun Aug 24 17:50:16 2014 +1000)
• 8c8aa89 - Added location of latest pact to output of pact:publish (Beth Skurrie, Sun Aug 24 17:43:02 2014 +1000)
• e6b56d0 - Added retries for pact publishing (Beth Skurrie, Sun Aug 24 16:55:10 2014 +1000)
• 27c00e5 - Disabled pacticipant version interactions, not needed yet. (Beth Skurrie, Sat May 17 17:57:33 2014 +1000)
• cfefdc4 - Changed path from /pact to /pacts (Beth Skurrie, Sat May 17 15:58:32 2014 +1000)

0.0.6 (2014-03-24)

• 2ad5f7d - Updated method of tagging versions (bethesque, Sat Mar 22 16:54:37 2014 +1100)
• b74128f - Added 'latest' pact url to pact representation in the 'latest pacts' response (bethesque, Sat Mar 22 09:04:31 2014 +1100)

0.0.5 (2014-01-03)

• 194183c - Removing debugger for Travis CI (bethesque, Fri Jan 3 12:45:07 2014 +1100)
• b42aba9 - Changed 'last' to 'latest' (bethesque, Tue Nov 19 09:30:12 2013 +1100)
• 30d63b7 - Changed name to title in list pacticipants response (bethesque, Mon Nov 18 09:37:11 2013 +1100)

0.0.4 (2013-11-15)

• cf33479 - Merge branch 'master' of github.com:bethesque/pact_broker-client (Beth, 20 hours ago)
• 01087ae - Fixed problem where PublicationTask block was evaluated at load time, instead of run time. (Beth, 20 hours ago)
• 2073234 - Updating to use example.org as the base URL (Beth, 2 days ago)
• 07073de - Updating latest pact URL (Beth, 2 days ago)

0.0.3 (2013-11-13)

• a3488bd - Fixing application/json+hal to application/hal+json (Beth, 2 days ago)
• 0fa89ef - Updating content type to match new Webmachine implementation. Removing redundant repository_url interaction. (Beth, 2 days ago)
• 9e1539e - Redoing the URLs yet again (Beth, 3 days ago)
• 9067b83 - Working on list latest pacts (Beth, 3 days ago)
• 3ba218a - Specifying pact/latest response (Beth, 6 days ago)
• b746f23 - Changing to new /pacts/latest URL format (Beth, 6 days ago)
• 39f52cf - Working on expected 'pacts/latest' response (Beth, 6 days ago)