Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release notes for 1.26.0 #257

Merged
merged 4 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 1 addition & 26 deletions website/docs/docs/on-premises/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ title: Environment variables
-->



## Logging

<hr/>
Expand Down Expand Up @@ -40,8 +41,6 @@ When true, HTTP request details and response status and duration will be logged
**Default:** `false`<br/>
**Allowed values:** `true`, `false`<br/>

<br/>

## Monitoring

<hr/>
Expand All @@ -56,8 +55,6 @@ Set this to true to enable New Relic application monitoring. The New Relic confi
**Default:** `false`<br/>
**Allowed values:** `true`, `false`<br/>

<br/>

## Database

<hr/>
Expand Down Expand Up @@ -178,8 +175,6 @@ Required for running Postgres on RDS with IAM authentication. This must be set t

**Required:** false<br/>

<br/>

## Webhooks

<hr/>
Expand Down Expand Up @@ -220,8 +215,6 @@ Whether or not to disable SSL verificaton when executing webhooks.
**Default:** `false`<br/>
**Allowed values:** `true`, `false`<br/>

<br/>

## SAML authentication

<hr/>
Expand Down Expand Up @@ -332,8 +325,6 @@ To allow for a small amount of clock drift between PactFlow and the Identity Pro
**Required:** false<br/>
**Default:** `0`<br/>

<br/>

## Demo authentication

<hr/>
Expand All @@ -348,8 +339,6 @@ Whether or not to enable authentication for demo users. For demonstration purpos
**Default:** `false`<br/>
**Allowed values:** `true`, `false`<br/>

<br/>

## Encryption

<hr/>
Expand All @@ -371,8 +360,6 @@ env LC_CTYPE=C tr -dc '_A-Z-a-z-0-9!#$%&*+-\\.^_|~' < /dev/urandom | fold -w 32
**Required:** true<br/>
**Example:** `eLM5xPxPu9ftDhA34ZUw2ry2okpMnOPCrA-twxLBUUk`<br/>

<br/>

## Secrets

<hr/>
Expand All @@ -385,8 +372,6 @@ Deprecated in favour of `PACTFLOW_MASTER_ENCRYPTION_KEY`. If you have a previous

**Required:** false<br/>

<br/>

## User administration

<hr/>
Expand All @@ -408,8 +393,6 @@ env LC_CTYPE=C tr -dc '_A-Z-a-z-0-9!#$%&*+-\\.^_|~' < /dev/urandom | fold -w 32
**Example:** `4wmplZfucVG-LdIHD9L`<br/>
**More information:** https://tools.ietf.org/html/rfc7230#section-3.2.6<br/>

<br/>

## Domain

<hr/>
Expand Down Expand Up @@ -452,8 +435,6 @@ This is to assist in the migration from using tags to track deployments to using
**Allowed values:** `true`, `false`<br/>
**More information:** https://docs.pact.io/pact_broker/recording_deployments_and_releases/<br/>

<br/>

## Badges

<hr/>
Expand All @@ -468,8 +449,6 @@ The URL of the free service that is used to generate the build badges. Note that
**Default:** `https://img.shields.io`<br/>
**More information:** https://shields.io<br/>

<br/>

## Resources

<hr/>
Expand Down Expand Up @@ -575,8 +554,6 @@ Whether or not to enable the embedded HAL Browser.
**Allowed values:** `true`, `false`<br/>
**More information:** https://github.com/mikekelly/hal-browser<br/>

<br/>

## Miscellaneous

<hr/>
Expand All @@ -590,8 +567,6 @@ The timezone in which to display dates for server side rendered pages.
**Required:** true<br/>
**More information:** [Valid timezones](/docs/on-premises/environment-variables/timezones)<br/>

<br/>

## API Tokens

<hr/>
Expand Down
51 changes: 51 additions & 0 deletions website/docs/docs/on-premises/releases/1.26.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: 1.26.0
---

## Release date

07 August 2023

## Features

* Support application/problem+json error response format for all non-200 responses
* [Major version upgrade of AJV](https://docs.pactflow.io/docs/bi-directional-contract-testing/contracts/oas/changelog) from v6 to v8 and Improve support for allOf, anyOf, oneOf, including polymorphic inheritance.
* Add new SCIM role to be assigned to the System Account that is used to access the PactFlow SCIM API.

## Fixes

* Fix error occuring when can-i-deploy badge is requested and no version is found
* Fix incorrect decoding of pact v4 bodies
* OAS now supports `exclusiveMinimum` and `exclusiveMaximum` correctly in request and response bodies
* Fix null pointer in role users endpoint

## Migration notes

### SCIM role migration

These migration steps are only relevant if the PactFlow SCIM API is in use.

1. Identify the System Account that is being used to access the SCIM API.
* Login to PactFlow as an Administrator.
* Click the Settings icon in the top right.
* Click the `Users` link in the left menu.
* Select `System Accounts` in the drop down box above the User list.
* Identify the relevant System Account and note the name.
2. Ensure that no role called `SCIM` exists.
mefellows marked this conversation as resolved.
Show resolved Hide resolved
* From the PactFlow Settings page, click the `Roles` link.
* If a role called `SCIM` exists, click the `EDIT` button, change the name (eg. `SCIM (Deprecated)`), and click `SAVE`
3. Perform the release as normal.
4. Assign the new SCIM role to the System Account identified in step 1.
* Login to PactFlow as an Administrator.
* Click the Settings icon in the top right.
* Click the `Users` link in the left menu.
* Select `System Accounts` in the drop down box above the User list.
* Locate the relevant System Account in the list.
* Click the `...` icon at the right of the row for the relevant System Account.
* Select `Edit roles`.
* Deselect the existing role.
* Select `SCIM`.
* Click `OK`
5. If there was a custom role previously used for the SCIM System Account, delete it.
* From the PactFlow Settings page, click the `Roles` link.
* Click the `DELETE` button next to the custom role.
8 changes: 8 additions & 0 deletions website/notices/2023-08-07-on-premises-1.26.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
slug: 2023-08-07-on-premises-1.26.0
title: On-premises release v1.26.0
tags: [on-premises, release]
---

A new PactFlow on-premises release (1.26.0) is now available ([see details](/docs/on-premises/releases/1.26.0)).

1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ module.exports = {
label: 'Releases',
items: [
//on-prem-release-placeholder
'docs/on-premises/releases/1.26.0',
'docs/on-premises/releases/1.25.0',
'docs/on-premises/releases/1.24.0',
'docs/on-premises/releases/1.23.1',
Expand Down