From 4c976e7db92c42afdbd3449d5009880664722114 Mon Sep 17 00:00:00 2001 From: Phanindra Srungavarapu Date: Thu, 22 Aug 2024 11:47:38 +0530 Subject: [PATCH 1/3] chore: add release notes for 1.31.0 --- scripts/release/release-notes-onprem.sh | 25 ++++++++++--- .../docs/on-premises/environment-variables.md | 2 +- .../docs/docs/on-premises/releases/1.31.0.md | 35 +++++++++++++++++++ .../notices/2024-08-22-on-premises-1.31.0.md | 8 +++++ website/sidebars.js | 1 + 5 files changed, 66 insertions(+), 5 deletions(-) create mode 100644 website/docs/docs/on-premises/releases/1.31.0.md create mode 100644 website/notices/2024-08-22-on-premises-1.31.0.md diff --git a/scripts/release/release-notes-onprem.sh b/scripts/release/release-notes-onprem.sh index 7d9f8788..0dafd6c3 100755 --- a/scripts/release/release-notes-onprem.sh +++ b/scripts/release/release-notes-onprem.sh @@ -44,7 +44,7 @@ BRANCH_NAME=release/$RELEASE_VERSION # Previous relase number #################### -provious_release_number=$(git ls-tree -r --name-only HEAD website/docs/docs/on-premises/releases | while read filename; do +previous_release_number=$(git ls-tree -r --name-only HEAD website/docs/docs/on-premises/releases | while read filename; do echo "$(git log --date=unix -1 --format="%ad" -- $filename) $filename" done | sort | tail -n1 | awk -F'/' '{print $NF}' | cut -d '.' -f 1-3) @@ -80,12 +80,12 @@ echo "Done." # Find SHA to diff against #################### -previous_tag=$(git tag -l --sort=-v:refname | grep -E "^$previous_release_number" | head -n 1) +previous_tag=$(git tag -l --sort=-v:refname | grep -E $previous_release_number | head -n 1) previous_tag_sha=$(git rev-list -n 1 $previous_tag) if [ -z ${DEV_TAG} ]; then - DEV_TAG=previous_tag_sha + DEV_TAG="$previous_tag_sha" echo "No tag provided, using previous tag $previous_tag_sha from $previous_tag" fi #################### @@ -116,15 +116,32 @@ if [ -n "$IS_RELEASE" ]; then echo "Creating ${RELEASE_VERSION} in Jira ${JIRA_PROJECT_ID}" payload_version="{\"archived\":false,\"name\":\"${RELEASE_VERSION}\",\"projectId\":${JIRA_PROJECT_ID},\"released\":false,\"description\":\"OnPrem Release for ${RELEASE_VERSION} by $JIRA_USER\"}" payload_issue="{\"update\": {\"fixVersions\": [{\"add\": {\"name\": \"${RELEASE_VERSION}\"}}]}}" + echo "payload_issue is $payload_issue" + echo "payload_version is $payload_version" + echo "JIRA_AUTH is $JIRA_AUTH" + response=$(curl -s --request POST \ --url "$JIRA_URL/rest/api/3/version" \ --user "$JIRA_AUTH" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data "${payload_version}") + echo "create version response is $response" error_message=$(echo $response | jq '.errorMessages') if [ "$error_message" != "null" ]; then - echo "Error creating version: $error_message" + # + # if you need to delete a version, which was created accidentally + # curl --request DELETE \ + # --url 'https://smartbear.atlassian.net/rest/api/3/version/41330' \ + # --user "$JIRA_AUTH" \ + # --header 'Accept: application/json' + # + # replace 41330 with version ID you want to delete + # you can see the version ID in jira UI + + echo "Error creating version: $error_message $response" + echo "Note: if you need to delete a version, which was created accidentally, you can use the following command: " + echo "curl --request DELETE --url 'https://smartbear.atlassian.net/rest/api/3/version/{id}' --user \"$JIRA_AUTH\" --header 'Accept: application/json'" exit 128 else echo "created version $RELEASE_VERSION" diff --git a/website/docs/docs/on-premises/environment-variables.md b/website/docs/docs/on-premises/environment-variables.md index 1baad0a0..6bdaaad4 100644 --- a/website/docs/docs/on-premises/environment-variables.md +++ b/website/docs/docs/on-premises/environment-variables.md @@ -63,7 +63,7 @@ Set this to true to enable New Relic application monitoring. The New Relic confi ### PACTFLOW_DATABASE_URL -The fully qualifed database connection string. If using Postgres on RDS with IAM authentication, the scheme must be `postgresiam` and the port must also be set. +The fully qualified database connection string. If using Postgres on RDS with IAM authentication, the scheme must be `postgresiam` and the port must also be set. **Required:** if separate host, name, username, password environment variables are not set
**Example:** `postgresql://username:password@host:port/database`
diff --git a/website/docs/docs/on-premises/releases/1.31.0.md b/website/docs/docs/on-premises/releases/1.31.0.md new file mode 100644 index 00000000..7ba71a2e --- /dev/null +++ b/website/docs/docs/on-premises/releases/1.31.0.md @@ -0,0 +1,35 @@ +--- +title: 1.31.0 +--- + +## Release date + +22 August 2024 + +## Features + +* added new /labels api that lists down all the labels + +## Fixes + +* 1. Fixes the NoMethodError for pacticipants PATCH request when request body contains embedded labels. +null +2. Documents the API which was missed previously ( /pacticipants/:pacticipant_name/labels/:label_name ) for managing labels for a pacticipant. +* Fixed unique team name issue when updating team in settings +* 1. Bumps openapi_first to major version 2.1 +null +2. Fixes the tests that were failing when updating the openapi_version beyond 1.0 +* Fix bug which caused a missing row in the matrix when there were a mix of classic Pact and bi-directional contracts +* Resolves the `UniqueConstraintViolation` issue when updating team users via a PUT request. +* Fixed incorrect type standardization for openapi -v 3.1.0 +* Team Administrators will now have permission to view environments. +* Resolves the authentication issue for newly invited users with sbid: true and no IDP subject. +* Resolution: Implement case-insensitive matching for existing SBID users experiencing login issues. +* deprecated _embedded payload format in the team update APIs +* Fixes an issue where deleting an integration in the context of BDCT leads to the unintended deletion of provider contracts. + +## Migration notes + +N/A + + diff --git a/website/notices/2024-08-22-on-premises-1.31.0.md b/website/notices/2024-08-22-on-premises-1.31.0.md new file mode 100644 index 00000000..20d7540a --- /dev/null +++ b/website/notices/2024-08-22-on-premises-1.31.0.md @@ -0,0 +1,8 @@ +--- +slug: 2024-08-22-on-premises-1.31.0 +title: On-premises release v1.31.0 +tags: [on-premises, release] +--- + +A new PactFlow on-premises release (1.31.0) is now available ([see details](/docs/on-premises/releases/1.31.0)). + diff --git a/website/sidebars.js b/website/sidebars.js index ee788347..7cee6139 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -427,6 +427,7 @@ module.exports = { label: 'Releases', items: [ //on-prem-release-placeholder + 'docs/on-premises/releases/1.31.0', 'docs/on-premises/releases/1.30.0', 'docs/on-premises/releases/1.29.0', 'docs/on-premises/releases/1.28.0', From 9f0462c9ce67459d90a1759503cceb09b93b587f Mon Sep 17 00:00:00 2001 From: Ilia Mogilevsky Date: Tue, 27 Aug 2024 09:55:01 +1000 Subject: [PATCH 2/3] chore: first pass at release notes for 1.31.0 --- .../docs/docs/on-premises/releases/1.31.0.md | 22 ++++++++----------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/website/docs/docs/on-premises/releases/1.31.0.md b/website/docs/docs/on-premises/releases/1.31.0.md index 7ba71a2e..0408a7d6 100644 --- a/website/docs/docs/on-premises/releases/1.31.0.md +++ b/website/docs/docs/on-premises/releases/1.31.0.md @@ -8,25 +8,21 @@ title: 1.31.0 ## Features -* added new /labels api that lists down all the labels +* Added new `/labels` API that lists all labels ## Fixes -* 1. Fixes the NoMethodError for pacticipants PATCH request when request body contains embedded labels. -null -2. Documents the API which was missed previously ( /pacticipants/:pacticipant_name/labels/:label_name ) for managing labels for a pacticipant. +* Fixes an issue where the "next" embedded link was not documented in the response body of the `GET /audit` +* Fixes the NoMethodError for pacticipants PATCH request when request body contains embedded labels +* Documents the API which was missed previously ( /pacticipants/:pacticipant_name/labels/:label_name ) for managing labels for a pacticipant * Fixed unique team name issue when updating team in settings -* 1. Bumps openapi_first to major version 2.1 -null -2. Fixes the tests that were failing when updating the openapi_version beyond 1.0 -* Fix bug which caused a missing row in the matrix when there were a mix of classic Pact and bi-directional contracts +* Fix bug which caused a missing row in the matrix when there are a mix of classic Pact and bi-directional contracts * Resolves the `UniqueConstraintViolation` issue when updating team users via a PUT request. * Fixed incorrect type standardization for openapi -v 3.1.0 -* Team Administrators will now have permission to view environments. -* Resolves the authentication issue for newly invited users with sbid: true and no IDP subject. -* Resolution: Implement case-insensitive matching for existing SBID users experiencing login issues. -* deprecated _embedded payload format in the team update APIs -* Fixes an issue where deleting an integration in the context of BDCT leads to the unintended deletion of provider contracts. +* Team Administrators will now have permission to view environments +* Deprecated _embedded payload format in the team update APIs +* Fixes an issue where deleting an integration in the context of BDCT leads to the unintended deletion of provider contracts +* Added provider version number to webhook endpoint ## Migration notes From 36b8cc79f2963042f00f5b4e43c86184154fd308 Mon Sep 17 00:00:00 2001 From: phanindra srungavarapu Date: Tue, 27 Aug 2024 10:31:35 +0530 Subject: [PATCH 3/3] fix: minor release note corrections from review Co-authored-by: Matt Fellows <53900+mefellows@users.noreply.github.com> --- website/docs/docs/on-premises/releases/1.31.0.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/on-premises/releases/1.31.0.md b/website/docs/docs/on-premises/releases/1.31.0.md index 0408a7d6..1824fccc 100644 --- a/website/docs/docs/on-premises/releases/1.31.0.md +++ b/website/docs/docs/on-premises/releases/1.31.0.md @@ -12,9 +12,9 @@ title: 1.31.0 ## Fixes -* Fixes an issue where the "next" embedded link was not documented in the response body of the `GET /audit` -* Fixes the NoMethodError for pacticipants PATCH request when request body contains embedded labels -* Documents the API which was missed previously ( /pacticipants/:pacticipant_name/labels/:label_name ) for managing labels for a pacticipant +* Fixes an issue where the "next" embedded link was not documented in the response body of the `GET /audit` endpoint +* Fixes the `NoMethodError` for pacticipants PATCH request when request body contains embedded labels +* Documents the API `/pacticipants/:pacticipant_name/labels/:label_name` for managing labels for a pacticipant * Fixed unique team name issue when updating team in settings * Fix bug which caused a missing row in the matrix when there are a mix of classic Pact and bi-directional contracts * Resolves the `UniqueConstraintViolation` issue when updating team users via a PUT request.