Skip to content

Commit

Permalink
Merge pull request #6249 from EnterpriseDB/docs/fix/relgenbugdirscan
Browse files Browse the repository at this point in the history
Fixes for relgen and refreshed PGD release notes (prev deleted)
  • Loading branch information
djw-m authored Nov 18, 2024
2 parents 4713c57 + b77aabb commit c32373f
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 104 deletions.
2 changes: 2 additions & 0 deletions product_docs/docs/pgd/5.6/rel_notes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ 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
---


Expand All @@ -11,3 +12,4 @@ The EDB Postgres Distributed documentation describes the latest version of EDB P

| 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 |
5 changes: 1 addition & 4 deletions product_docs/docs/pgd/5.6/rel_notes/pgd_5.6.0_rel_notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ title: EDB Postgres Distributed 5.6.0 release notes
navTitle: Version 5.6.0
---


Released: 15 October 2024


EDB Postgres Distributed 5.6.0 includes a number of enhancements and bug fixes.


## Highlights

- Improved observability with new monitoring functions and SQL views.
- Improvements to commit scopes including:
- GROUP COMMIT and SYNCHRONOUS COMMIT support graceful degrading using DEGRADE ON.
Expand All @@ -26,7 +24,6 @@ EDB Postgres Distributed 5.6.0 includes a number of enhancements and bug fixes.
- CREATE SCHEMA AUTHORIZATION
- Streaming Transaction support with Decoding Worker.


## Enhancements

<table class="table w-100"><thead><tr><th>Component</th><th>Version</th><th>Description</th><th width="10%">Addresses</th></tr></thead><tbody>
Expand Down
93 changes: 0 additions & 93 deletions product_docs/docs/tpa/23/rel_notes/tpa_23.35_rel_notes.mdx

This file was deleted.

26 changes: 19 additions & 7 deletions tools/automation/generators/relgen/relgen.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,11 @@ let meta = load(readFileSync(path.join(basepath, "src/meta.yml"), "utf8"));

let files = readdirSync(path.join(basepath, "src"), { withFileTypes: true })
.filter((dirent) => {
dirent.isFile() && dirent.name !== "meta.yml";
return (
dirent.isFile() &&
dirent.name !== "meta.yml" &&
dirent.name.endsWith(".yml")
);
})
.map((dirent) => dirent.name);

Expand Down Expand Up @@ -205,6 +209,14 @@ appendFileSync(relindexfilename, "\n\n");
appendFileSync(relindexfilename, `${meta.intro}`);
appendFileSync(relindexfilename, "\n\n");

// Before we process the table, is there a column definition. If not, we'll use a default
if (meta.columns == undefined) {
meta.columns = [
{ label: "Version", key: "version-link" },
{ label: "Release Date", key: "shortdate" },
];
}

let headers = "|";
let headers2 = "|";
for (let i = 0; i < meta.columns.length; i++) {
Expand Down Expand Up @@ -332,23 +344,23 @@ function prepareRelnote(meta, file, note) {
);
appendFileSync(rlout, `navTitle: Version ${note.version}\n`);
appendFileSync(rlout, `---\n`);
appendFileSync(rlout, "\n\n");
appendFileSync(rlout, "\n");
appendFileSync(rlout, `Released: ${note.date}\n`);
appendFileSync(rlout, "\n\n");
appendFileSync(rlout, "\n");

if (note.updated !== undefined) {
appendFileSync(rlout, `Updated: ${note.updated}\n`);
appendFileSync(rlout, "\n\n");
appendFileSync(rlout, "\n");
}

appendFileSync(rlout, `${note.intro}`);
appendFileSync(rlout, "\n\n");
appendFileSync(rlout, "\n");

if (note.highlights !== undefined) {
appendFileSync(rlout, `## Highlights`);
appendFileSync(rlout, "\n");
appendFileSync(rlout, `${note.highlights}`);
appendFileSync(rlout, "\n\n");
appendFileSync(rlout, `${note.highlights}`);
appendFileSync(rlout, "\n");
}

for (let type of types) {
Expand Down

1 comment on commit c32373f

@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.

Please sign in to comment.