Skip to content

Commit

Permalink
Merge pull request #6184 from EnterpriseDB/docs/tools/relnote-generat…
Browse files Browse the repository at this point in the history 
…or-two

Relgen: Second gen relnotes generator first commit.
  • Loading branch information
@djw-m
djw-m authored Nov 18, 2024
2 parents 2441c31 + f9a21f9 commit 4713c57
Show file tree
Hide file tree
Showing 28 changed files with 2,596 additions and 86 deletions.
2 changes: 0 additions & 2 deletions docker/docker-compose.build-pdf.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: "3.8"

services:
docs-pdf-builder:
build:
Expand Down
23 changes: 23 additions & 0 deletions gatsby-browser.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,26 @@ function scrollToAnchor(location, mainNavHeight = 0) {

return true;
}

exports.onInitialClientRender = () => {
// h/t https://stackoverflow.com/questions/19646684/force-open-the-details-summary-tag-for-print-in-chrome/75260733#75260733
window.matchMedia("print").addEventListener("change", (evt) => {
if (evt.matches) {
let detailsElements = document.body.querySelectorAll(
"details:not([open])",
);
for (let e of detailsElements) {
e.toggleAttribute("open", true);
e.dataset.wasclosed = "";
}
} else {
let detailsElements = document.body.querySelectorAll(
"details[data-wasclosed]",
);
for (let e of detailsElements) {
e.removeAttribute("open");
delete e.dataset.wasclosed;
}
}
});
};
25 changes: 8 additions & 17 deletions product_docs/docs/pgd/5.6/rel_notes/index.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
---
title: "EDB Postgres Distributed 5.6+ release notes"
navTitle: "Release notes"
description: "Release notes for EDB Postgres Distributed 5.6+"
title: EDB Postgres Distributed 5.6+ release notes
navTitle: Release notes
description: Release notes for EDB Postgres Distributed 5.6 and later
navigation:
- pgd_5.6.0_rel_notes
redirects:
- /bdr/latest/release_notes/bdr4_rel_notes/
- /bdr/latest/release_notes/bdr4.0.1_rel_notes/
- /pgd/latest/overview/harp/01_release_notes/
---

The EDB Postgres Distributed documentation describes the latest version of EDB
Postgres Distributed 5, including minor releases and patches. The release notes
provide information on what was new in each release. For new functionality
introduced in a minor or patch release, the content also indicates the release
that introduced the feature.

| Release Date | EDB Postgres Distributed | BDR extension | PGD CLI | PGD Proxy |
|--------------|------------------------------|---------------|---------|-----------|
| 15 Oct 2024 | [5.6.0](pgd_5.6.0_rel_notes) | 5.6.0 | 5.6.0 | 5.6.0 |
| | | | | |
The EDB Postgres Distributed documentation describes the latest version of EDB Postgres Distributed 5, including minor releases and patches. The release notes provide information on what was new in each release. For new functionality introduced in a minor or patch release, the content also indicates the release that introduced the feature.


| Release Date | EDB Postgres Distributed | BDR extension | PGD CLI | PGD Proxy |
|---|---|---|---|---|
6 changes: 3 additions & 3 deletions product_docs/docs/pgd/5.6/rel_notes/pgd_5.6.0_rel_notes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ EDB Postgres Distributed 5.6.0 includes a number of enhancements and bug fixes.

## Enhancements

<table class="table"><thead><tr><th>Component</th><th>Version</th><th>Release Note</th><th>Addresses</th></tr></thead><tbody>
<table class="table w-100"><thead><tr><th>Component</th><th>Version</th><th>Description</th><th width="10%">Addresses</th></tr></thead><tbody>
<tr><td>BDR</td><td>5.6.0</td><td><details><summary>Decoding Worker supports Streaming Transactions</summary><hr/><p>One of the main advantages of streaming is that the WAL sender sends the partial transaction before it commits, which reduces replication lag. Now, with streaming support, the WAL decoder does the same thing, but it streams to the LCRs segments. Eventually, the WAL sender will read the LCRs and mimic the same behavior of streaming large transactions before they commit. This provides the benefits of decoding worker, such as reduced CPU and disk space, as well as the benefits of streaming, such as reduced lag and disk space, since &quot;.spill&quot; files are not generated.
The WAL decoder always streams the transaction to LCRs, but based on downstream requests, the WAL sender either streams the transaction or just mimics the normal BEGIN..COMMIT scenario.
In addition to the normal LCRs segment files, we create streaming files with the starting names <code>TR_TXN_&lt;file-name-format&gt;</code> and <code>CAS_TXN_&lt;file-name-format&gt;</code> for each streamed transaction.</p>
Expand Down Expand Up @@ -120,14 +120,14 @@ any node in a subgroup and does not need to be redefined for every subgroup
anymore. This is particularly useful when combined with <code>ORIGIN\_GROUP</code>
keyword to reduce the complexity of commit scope setup.</p>
</details></td><td></td></tr>
<tr><td>CLI</td><td>5.6.0</td><td><details><summary>Use bdr.bdr_file_settings view in verify-settings</summary><hr/><p>Use bdr.bdr_file_settings view to get the current settings for the proxy.</p>
<tr><td>PGD CLI</td><td>5.6.0</td><td><details><summary>Use bdr.bdr_file_settings view in verify-settings</summary><hr/><p>Use bdr.bdr_file_settings view to get the current settings for the proxy.</p>
</details></td><td></td></tr>
</tbody></table>


## Bug Fixes

<table class="table"><thead><tr><th>Component</th><th>Version</th><th>Release Note</th><th>Addresses</th></tr></thead><tbody>
<table class="table w-100"><thead><tr><th>Component</th><th>Version</th><th>Description</th><th width="10%">Addresses</th></tr></thead><tbody>
<tr><td>BDR</td><td>5.6.0</td><td><details><summary>Fixed buffer overrun in the writer</summary><hr/><p>Include an extra zero byte at the end of a column value allocation in shared memory queue insert/update/delete messages.</p>
</details></td><td>98966</td></tr>
<tr><td>BDR</td><td>5.6.0</td><td>Fixes for some race conditions to prevent node sync from entering a hung state with the main subscription disabled.</td><td></td></tr>
Expand Down
24 changes: 24 additions & 0 deletions product_docs/docs/pgd/5.6/rel_notes/src/meta.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
product: EDB Postgres Distributed
shortname: pgd
title: EDB Postgres Distributed 5.6+ release notes
description: Release notes for EDB Postgres Distributed 5.6 and later
intro: |
The EDB Postgres Distributed documentation describes the latest version of EDB Postgres Distributed 5, including minor releases and patches. The release notes provide information on what was new in each release. For new functionality introduced in a minor or patch release, the content also indicates the release that introduced the feature.
columns:
- 0:
label: Release Date
key: shortdate
- 1:
label: "EDB Postgres Distributed"
key: version-link
- 2:
label: "BDR extension"
key: $bdrextension
- 3:
label: "PGD CLI"
key: $pgdcli
- 4:
label: "PGD Proxy"
key: $pgdproxy
components: [ "BDR", "PGD CLI", "PGD Proxy", "Utilities" ]

6 changes: 5 additions & 1 deletion product_docs/docs/pgd/5.6/rel_notes/src/relnote_5.6.0.yml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
product: EDB Postgres Distributed
version: 5.6.0
date: 15 October 2024
meta:
bdrextension: 5.6.0
pgdcli: 5.6.0
pgdproxy: 5.6.0
intro: |
EDB Postgres Distributed 5.6.0 includes a number of enhancements and bug fixes.
highlights: |
Expand Down Expand Up @@ -415,7 +419,7 @@ relnotes:
severity: High
impact: High
- relnote: Use bdr.bdr_file_settings view in verify-settings
component: CLI
component: PGD CLI
component_version: 5.6.0
details: |
Use bdr.bdr_file_settings view to get the current settings for the proxy.
Expand Down
110 changes: 56 additions & 54 deletions product_docs/docs/tpa/23/rel_notes/index.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,61 +1,63 @@
---
title: Trusted Postgres Architect release notes
navTitle: "Release notes"
navTitle: Release notes
description: Release notes for Trusted Postgres Architect and later
navigation:
- tpa_23.34.1_rel_notes
- tpa_23.34_rel_notes
- tpa_23.33_rel_notes
- tpa_23.32_rel_notes
- tpa_23.31_rel_notes
- tpa_23.30_rel_notes
- tpa_23.29_rel_notes
- tpa_23.28_rel_notes
- tpa_23.27_rel_notes
- tpa_23.26_rel_notes
- tpa_23.25_rel_notes
- tpa_23.24_rel_notes
- tpa_23.23_rel_notes
- tpa_23.22_rel_notes
- tpa_23.21_rel_notes
- tpa_23.20_rel_notes
- tpa_23.19_rel_notes
- tpa_23.18_rel_notes
- tpa_23.17_rel_notes
- tpa_23.16_rel_notes
- tpa_23.15_rel_notes
- tpa_23.14_rel_notes
- tpa_23.13_rel_notes
- tpa_23.12_rel_notes
- tpa_23.1-11_rel_notes
- tpa_23.34.1_rel_notes
- tpa_23.34_rel_notes
- tpa_23.33_rel_notes
- tpa_23.32_rel_notes
- tpa_23.31_rel_notes
- tpa_23.30_rel_notes
- tpa_23.29_rel_notes
- tpa_23.28_rel_notes
- tpa_23.27_rel_notes
- tpa_23.26_rel_notes
- tpa_23.25_rel_notes
- tpa_23.24_rel_notes
- tpa_23.23_rel_notes
- tpa_23.22_rel_notes
- tpa_23.21_rel_notes
- tpa_23.20_rel_notes
- tpa_23.19_rel_notes
- tpa_23.18_rel_notes
- tpa_23.17_rel_notes
- tpa_23.16_rel_notes
- tpa_23.15_rel_notes
- tpa_23.14_rel_notes
- tpa_23.13_rel_notes
- tpa_23.12_rel_notes
- tpa_23.1-11_rel_notes
---

The Trusted Postgres Architect documentation describes the latest version of Trusted Postgres Architect 23.

| Version | Release date |
| ---------------------------- | ------------ |
| [23.34.1](tpa_23.34.1_rel_notes) | 09 Sep 2024 |
| [23.34](tpa_23.34_rel_notes) | 22 Aug 2024 |
| [23.33](tpa_23.33_rel_notes) | 24 Jun 2024 |
| [23.32](tpa_23.32_rel_notes) | 15 May 2024 |
| [23.31](tpa_23.31_rel_notes) | 19 Mar 2024 |
| [23.30](tpa_23.30_rel_notes) | 19 Mar 2024 |
| [23.29](tpa_23.29_rel_notes) | 15 Feb 2024 |
| [23.28](tpa_23.28_rel_notes) | 23 Jan 2024 |
| [23.27](tpa_23.27_rel_notes) | 19 Dec 2023 |
| [23.26](tpa_23.26_rel_notes) | 30 Nov 2023 |
| [23.25](tpa_23.25_rel_notes) | 14 Nov 2023 |
| [23.24](tpa_23.24_rel_notes) | 17 Oct 2023 |
| [23.23](tpa_23.23_rel_notes) | 21 Sep 2023 |
| [23.22](tpa_23.22_rel_notes) | 06 Sep 2023 |
| [23.21](tpa_23.21_rel_notes) | 05 Sep 2023 |
| [23.20](tpa_23.20_rel_notes) | 01 Aug 2023 |
| [23.19](tpa_23.19_rel_notes) | 12 Jul 2023 |
| [23.18](tpa_23.18_rel_notes) | 23 May 2023 |
| [23.17](tpa_23.17_rel_notes) | 10 May 2023 |
| [23.16](tpa_23.16_rel_notes) | 21 Mar 2023 |
| [23.15](tpa_23.15_rel_notes) | 15 Mar 2023 |
| [23.14](tpa_23.14_rel_notes) | 23 Feb 2023 |
| [23.13](tpa_23.13_rel_notes) | 22 Feb 2023 |
| [23.12](tpa_23.12_rel_notes) | 21 Feb 2023 |
| [23.1-11](tpa_23.1-11_rel_notes)| - |
The Trusted Postgres Architect documentation describes the latest version of Trusted Postgres Architect 23.


| Trusted Postgres Architect version | Release Date |
|---|---|
| [23.34.1](./tpa_23.34.1_rel_notes) | 09 Sep 2024 |
| [23.34](./tpa_23.34_rel_notes) | 22 Aug 2024 |
| [23.33](./tpa_23.33_rel_notes) | 24 Jun 2024 |
| [23.32](./tpa_23.32_rel_notes) | 15 May 2024 |
| [23.31](./tpa_23.31_rel_notes) | 19 Mar 2024 |
| [23.30](./tpa_23.30_rel_notes) | 19 Mar 2024 |
| [23.29](./tpa_23.29_rel_notes) | 15 Feb 2024 |
| [23.28](./tpa_23.28_rel_notes) | 23 Jan 2024 |
| [23.27](./tpa_23.27_rel_notes) | 19 Dec 2023 |
| [23.26](./tpa_23.26_rel_notes) | 30 Nov 2023 |
| [23.25](./tpa_23.25_rel_notes) | 14 Nov 2023 |
| [23.24](./tpa_23.24_rel_notes) | 17 Oct 2023 |
| [23.23](./tpa_23.23_rel_notes) | 21 Sep 2023 |
| [23.22](./tpa_23.22_rel_notes) | 06 Sep 2023 |
| [23.21](./tpa_23.21_rel_notes) | 05 Sep 2023 |
| [23.20](./tpa_23.20_rel_notes) | 01 Aug 2023 |
| [23.19](./tpa_23.19_rel_notes) | 12 Jul 2023 |
| [23.18](./tpa_23.18_rel_notes) | 23 May 2023 |
| [23.17](./tpa_23.17_rel_notes) | 10 May 2023 |
| [23.16](./tpa_23.16_rel_notes) | 21 Mar 2023 |
| [23.15](./tpa_23.15_rel_notes) | 15 Mar 2023 |
| [23.14](./tpa_23.14_rel_notes) | 23 Feb 2023 |
| [23.13](./tpa_23.13_rel_notes) | 22 Feb 2023 |
| [23.12](./tpa_23.12_rel_notes) | 21 Feb 2023 |
| [23.1-11](./tpa_23.1-11_rel_notes) | 21 Jun 2023 to 31 Jan 2023 |
142 changes: 142 additions & 0 deletions product_docs/docs/tpa/23/rel_notes/src/draft/tpa_23.35_rel_notes.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
product: Trusted Postgres Architect
version: 23.35
date: 29 October 2024
intro: |
New features, enhancements, bug fixes, and other changes in Trusted Postgres Architect 23.35 include the following:
highlights: |
- More Trust
- More Postgres
- More Architect
relnotes:
- details: |
`PermissionsStartOnly` has been deprecated and is now achieved via `ExecStartPost=+/bin/bash...` syntax.
relnote: Remove deprecated `PermissionStartOnly` in postgres.service.j2 template
impact: low
jira:
- TPA-762
type: Change
- details: |
Fixed a bug whereby the test that ensures the current pgd-proxy configuration
matches the expected configuration would fail for version < 5.5.0. This fix ensures
that TPA won't try to query configuration keys added in version 5.5.0.
impact: low
jira:
- TPA-819
relnote: Fix tpaexec test for pgd-proxy config verification
type: Bug Fix
- details: |
The PostGIS package will automatically be added when a user specifies `postgis`
as an entry in either `postgres_extensions` or the list of extensions named under
`postgres_databases`. Also enables the CRB (Code Ready Builder) repository for
RHEL-compatible distributions so PostGIS dependencies can be installed.
impact: low
jira:
- TPA-771
relnote: Add `postgis` to list of recognized extensions
type: Change
- details: |
Certain required privileges are granted to Postgres role, `barman_role`,
which is then granted to the `barman` Postgres user. This avoids creating the
`barman` user as a superuser. This role can also be granted to other Postgres
users by adding it to their `granted_roles` list using `postgres/createuser`. The
`barman_role` is created as part of the Barman tasks; if Barman is not used, this
role will not be created. Therefore, the task that grants privileges to this role
is only executed if the `barman_role` username is in the list of Postgres users
that are created. The ''barman'' user now has `NOSUPERUSER` explicitly specified
as a role attribute. If a cluster was deployed with a previous TPA version (which
created the ''barman'' user as a superuser), deploying with this version will
remove the `superuser` role attribute from the `barman` user.
impact: low
jira:
- TPA-148
- TPA-818
relnote: The `barman` Postgres user should not be a superuser
type: Change
- details: |
A `primary_slot_name` is configured on the primary node to ensure the
old primary uses a physical slot for replication during an EFM switchover. However,
''bdr_init_physical'' attempts to use it for node initialisation and hangs indefinitely
since the slot does not exist in a PGD installation. This `primary_slot_name`
is now conditionally set explicitly when the `failover_manager` is EFM to avoid
setting it unnecessarily.
impact: low
jira:
- TPA-712
relnote: '`primary_slot_name` added for EFM compatibility interferes with `bdr_init_physical` '
type: Bug Fix
- details: |
If the `pgdcli_package_version` is specified in `config.yml`, the `bash-completion`
package is incorrectly named because the `packages_for` filter erroneously appends
the `pgdcli_package_version` to the package name. This results in an attempt
to download a nonexistant package. The `bash-completion` package is now appended
to the list after the `packages_for` filter, since it''s version is independent
from the `pgdcli_package_version`.
impact: low
jira:
- TPA-794
relnote: Download correct `bash-completion` package version
type: Bug Fix
- details: |
Fixed an issue whereby in some cases error messages would be repeated
even after successful tasks.
impact: low
jira:
- TPA-812
relnote: Clear error message stack after each task
type: Bug Fix
- details: |
Improve postgres-monitor script to better manage recoverable errors and
add retries on network errors to ensure that it won''t return failure when it
just didn't allow enough time for postgres service to be fully started.
impact: low
jira:
- TPA-796
relnote: Improve postgres-monitor script
type: Change
- details: |
Fixed an issue whereby new replicas in patroni clusters would fail with
errors related to replication slots.
impact: low
jira:
- TPA-792
- TPA-781
relnote: Enable new replicas in patroni clusters
type: Bug Fix
- details: |
A support ticket questioned why the `pemserver` and `barman` nodes are
added to the `Allowed node host list` in EFM when they are not relevant to EFM
functions. Refactored the task that writes the `efm.node` configuration to only
include those nodes that have `efm` in their list of roles.
impact: low
jira:
- TPA-817
relnote: Only add nodes with `efm` role to cluster `efm.nodes` file
type: Change
- details: |
'If `--enable-pem` and `--enable-pg-backup-api` are passed to `tpaexec
configure`, `pem-agent` is added twice to the `barman` node if it is also a `witness`. Fixed
by by consolidating both `if` statements together to only evaluate the conditions
once. '
impact: low
jira:
- TPA-793
relnote: Add `pem-agent` role on barman nodes at most once for M1 architecture
type: Bug Fix
- details: |
Fixed a bug whereby if the user excluded the `pkg` selector, later pem-related
tasks would fail because the pem_python_executable fact had not been set.
impact: low
jira:
- TPA-814
relnote: set pem_python_executable outside pkg role
type: Bug Fix
- details: |
The `--efm-install-path` and `--efm-cluster-name` flags are set when a PEM
server is registered on an EFM node. The `Streaming Replication`, `Failover
Manager Node Status` and `Failover Manager Cluster Info` probes are enabled when
a PEM agent is registered on an EFM node. '
impact: low
jira:
- TPA-586
relnote: Enable EFM probes when a PEM agent is registered on an EFM node
type: Change
Loading

1 comment on commit 4713c57

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://673b233d7f5541773bc60a50--edb-docs-staging.netlify.app

Please sign in to comment.