pact_broker 2.98.0 → 2.101.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9aac85ace2c0ba5eaacc6fe462dbe4fc3d7623414f13a9bf351bc70d7a8b37f
-  data.tar.gz: 8bae3685f8b675c447aa986c0629875dad4e5e5e614411dea6ca75d77ed0918d
+  metadata.gz: '08222ce855214163448e53d62e9beea5b6b04c5fc6f9e56308ac27984c21599a'
+  data.tar.gz: 2e5f39087b8ff5a7b906d179554ba701043619910923465b10611fe198736a53
 SHA512:
-  metadata.gz: d2249bef385597430fa0f9c296a4b83e489a71dc027b681f60c57e82efe6805403ae9054d996afeb2a65c20fa7f363e868dd754b4a589249c7a639e86b616c9d
-  data.tar.gz: 60605b088a39d895374fc10028525b012b7d3a33579ade4f9f3c9119b014fbbf7857a18bb2f09147c65059d35f37a0858fcd126a408ba010dbd1c82ccc7e7788
+  metadata.gz: 4bb5843f3f1fc44f56bfeea79d2315ecb61c278ebdbb089e8cd5405784f39ba4475c0a04bdeaddd179a5bf863fa46139f76692ebaff3c8185abc8c21075544e6
+  data.tar.gz: 6982da454c1f364143d0d3abd11777c25a8114dbd3dd6ab6c5987dadb2239e804dee6ec124ada34f7d8a1aabe62dabf29047bb12f0a48f306fb29ee7a54ca111

data/CHANGELOG.md

@@ -1,3 +1,63 @@
+<a name="v2.101.0"></a>
+### v2.101.0 (2022-06-07)
+
+#### Features
+
+* recalculate the branch head if the deleted branch version was the latest for the branch	 ([db51d4fe](/../../commit/db51d4fe))
+* support deleting branch versions (removing a version from a branch)	 ([661667b3](/../../commit/661667b3))
+* improve error message when request has non UTF-8 characters (#559)	 ([3addc0c8](/../../commit/3addc0c8))
+
+#### Bug Fixes
+
+* add missing environment policy record for use when recording deployments	 ([09bb02a6](/../../commit/09bb02a6))
+* fix bug where pacticipant with blank name was being created instead of updating existing record	 ([be24a8ad](/../../commit/be24a8ad))
+* ensure pacticipant name is retained when updating with PUT	 ([eeac47c3](/../../commit/eeac47c3))
+
+<a name="v2.100.0"></a>
+### v2.100.0 (2022-05-20)
+
+#### Features
+
+* check for potential duplicate pacticipants in publish contracts endpoint (#558)	 ([ed714f03](/../../commit/ed714f03))
+* add support for "can i merge" matrix query	 ([bb108ed2](/../../commit/bb108ed2))
+* remove inefficient skynet query for tags	 ([bdc2599c](/../../commit/bdc2599c))
+* update text for matrix version description when no version is in an enviroment	 ([3eb5581d](/../../commit/3eb5581d))
+
+* **pacts for verification**
+  * update wip and pending descriptions for wip pacts	 ([b06d4477](/../../commit/b06d4477))
+
+* **matrix**
+  * add support for selectors specified by branch and environment name when reporting that a version does not exist	 ([07ff8044](/../../commit/07ff8044))
+
+#### Bug Fixes
+
+* **matrix**
+  * identify the correct failed version when a selector resolves to multiple versions	 ([11e7dc1c](/../../commit/11e7dc1c))
+
+<a name="v2.99.0"></a>
+### v2.99.0 (2022-05-13)
+
+#### Features
+
+* remove disable_use_branch_heads_for_latest_branch_pacts feature toggle	 ([5c6f1766](/../../commit/5c6f1766))
+* remove new_wip_calculation feature toggle	 ([add6cb08](/../../commit/add6cb08))
+* timeout long running pact content diff requests (#555)	 ([88abb2cf](/../../commit/88abb2cf))
+* change sql_log_level default from debug to none	 ([9f7aed46](/../../commit/9f7aed46))
+
+#### Bug Fixes
+
+* **ui**
+  * fix unescaped pacticipant name and main branch in details and network pages	 ([b8b1d306](/../../commit/b8b1d306))
+
+* return a 400 when invalid JSON is used to create a version	 ([9af2cfaf](/../../commit/9af2cfaf))
+* only log API requests/responses, not web assets, when http_debug_logging_enabled is true	 ([1f232c08](/../../commit/1f232c08))
+
+* **matrix**
+  * fix performance issue when querying matrix with one selector	 ([3a08d128](/../../commit/3a08d128))
+
+* **pacts for verification**
+  * return the pacts for the branch heads when using the branch selector	 ([6dac495e](/../../commit/6dac495e))
+
 <a name="v2.98.0"></a>
 ### v2.98.0 (2022-03-29)
 

data/Gemfile

@@ -30,6 +30,7 @@ group :test do
   gem "faraday_middleware", "~> 0.14"
   gem "docker-api", "~>1.34"
   gem "approvals", ">=0.0.24", "<1.0.0"
+  gem "tzinfo", "~>2.0"
 end
 
 if ENV["INSTALL_MYSQL"] == "true"

data/docs/CONFIGURATION.md

@@ -57,6 +57,7 @@ While the default is `file` for the Ruby application, it is set to `stdout` on t
 
 Enable this setting to print the entire request and response to the logs at debug level. Used for troubleshooting issues.
 Do not leave this on permanently, as it will have performance and security issues.
+Ensure the application [`log_level`](#log_level) is set to `debug` when this setting is enabled.
 
 **Supported versions:** From v2.98.0<br/>
 **Environment variable name:** `PACT_BROKER_HTTP_DEBUG_LOGGING_ENABLED`<br/>
@@ -156,7 +157,7 @@ To disable noisy SQL query logging when the application `log_level` is set to `d
 
 **Environment variable name:** `PACT_BROKER_SQL_LOG_LEVEL`<br/>
 **YAML configuration key name:** `sql_log_level`<br/>
-**Default:** `debug`<br/>
+**Default:** From 2.99+, the default is `none`. In previous versions, the default is `debug`.<br/>
 **Allowed values:** `none`, `debug`, `info`, `warn`, `error`, `fatal`<br/>
 
 ### sql_log_warn_duration
@@ -654,6 +655,15 @@ with a unique version number.
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://docs.pact.io/versioning<br/>
 
+### pact_content_diff_timeout
+
+The maximum amount of time in seconds to attempt to generate the diff between two pacts before aborting the request. This is required due to performance issues in the underlying diff generation code.
+
+**Supported versions:** From 2.99.0<br/>
+**Environment variable name:** `PACT_BROKER_PACT_CONTENT_DIFF_TIMEOUT`<br/>
+**YAML configuration key name:** `pact_content_diff_timeout`<br/>
+**Default:** `15`<br/>
+
 <br/>
 
 ## Miscellaneous

data/docs/api/PACTICIPANTS.md

@@ -0,0 +1,290 @@
+
+# Pacticipants
+
+
+## Pacticipant
+
+Path: `/pacticipants/:pacticipant_name`<br/>
+Allowed methods: `GET`, `PUT`, `PATCH`, `DELETE`<br/>
+
+### GET
+
+#### Request
+
+Headers: `{"Accept":"application/hal+json"}`<br/>
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example-organization/foo",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+
+### PUT
+
+PUT replaces the entire resource with the specified body, so missing properties will effectively be nulled. Embedded properties (eg. versions) will not be affected.
+
+#### Request
+
+Headers: `{"Content-Type":"application/json","Accept":"application/hal+json"}`<br/>
+Body:
+
+```
+{
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main"
+}
+```
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+
+### PATCH
+
+PATCH with the Content-Type application/merge-patch+json merges the pacticipant's existing properties with those from the request body. Embedded properties (eg. versions) will not be affected.
+
+#### Request
+
+Headers: `{"Content-Type":"application/merge-patch+json","Accept":"application/hal+json"}`<br/>
+Body:
+
+```
+{
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main"
+}
+```
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+