Merge pull request #298 from pactflow/release/1.31.0

chore: add release notes for 1.31.0

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"

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<br/>
 **Example:** `postgresql://username:password@host:port/database`<br/>

website/docs/docs/on-premises/releases/1.31.0.md

@@ -0,0 +1,31 @@
+---
+title: 1.31.0
+---
+
+## Release date
+
+22 August 2024
+
+## Features
+
+* Added new `/labels` API that lists all labels
+
+## Fixes
+
+* 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.
+* Fixed incorrect type standardization for openapi -v 3.1.0
+* 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
+
+N/A
+
+

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)).
+

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',