puter/paseo
1
0
Fork 0
mirror of https://github.com/getpaseo/paseo.git synced 2026-11-10 10:25:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(changelog): make every surface split a release the same way

Browse Source 
The app, the website and the release scripts each parse CHANGELOG.md with
their own code, and only the app skipped fenced code blocks and read CRLF.
A `###` or a release heading inside a fenced example in a highlight would
have ended the highlights early on the website and in the GitHub release
body, or started a phantom release, while the app showed it correctly.

The website and script parsers now follow the app's rules, and one case
file, scripts/test-support/changelog-structure.json, is run by all three
suites so a rule cannot change in one place only.

The release-notes script tests were not part of any CI job; they now run
with the other script contract tests.
This commit is contained in:
Mohamed Boudra
2026-11-10 10:04:33 +01:00
parent eda939b092
commit ccdca942e9
8 changed files with 361 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/changelog-utils.mjs
+31 -4
View File
@@ -1,18 +1,24 @@
// One definition of how CHANGELOG.md is structured. Consumed by the GitHub release
// notes sync and by the F-Droid changelog sync, which need the same section bodies
// rendered two different ways.
//
// The app's What's new sheet and the website parse the same file with their own
// code. `test-support/changelog-structure.json` holds the cases all three must
// split the same way; a change to the structure rules starts there.
const headingPattern = /^##\s+\[?([^\]\s]+)\]?\s*-\s*([0-9]{4}-[0-9]{2}-[0-9]{2})\s*$/;
const sectionHeadingPattern = /^###\s+(.+?)\s*$/;
const sectionHeadingPattern = /^ {0,3}###(?:[ \t]+(.*?))?[ \t]*$/;
const fencePattern = /^\s*(`{3,}|~{3,})/;
const bulletPattern = /^\s*[-*]\s+(.+?)\s*$/;
const blockquotePattern = /^\s*>\s?(.*)$/;
// Returns entries newest-first, matching the order they appear in the file.
export function parseChangelogEntries(changelogText) {
const lines = changelogText.split(/\r?\n/);
const fenced = markFencedLines(lines);
const headings = [];
for (let index = 0; index < lines.length; index += 1) {
const match = lines[index].match(headingPattern);
const match = fenced[index] ? null : lines[index].match(headingPattern);
if (!match) {
continue;
}
@@ -51,7 +57,10 @@ export function parseChangelogEntries(changelogText) {
// release's highlights; the sections after it are the full record. Either part is
// empty when the entry has none.
export function splitChangelogHighlights(bodyLines) {
const firstSection = bodyLines.findIndex((line) => sectionHeadingPattern.test(line));
const fenced = markFencedLines(bodyLines);
const firstSection = bodyLines.findIndex(
(line, index) => !fenced[index] && sectionHeadingPattern.test(line),
);
const split = firstSection === -1 ? bodyLines.length : firstSection;
return {
highlightLines: trimBlankLines(bodyLines.slice(0, split)),
@@ -59,6 +68,24 @@ export function splitChangelogHighlights(bodyLines) {
};
}
// Flags the lines that belong to a fenced code block, edges included. A `##` or
// `###` in there is an example, so it starts neither a release nor a section.
function markFencedLines(lines) {
let fence = null;
return lines.map((line) => {
const edge = line.match(fencePattern)?.[1];
if (!edge) {
return fence !== null;
}
if (fence === null) {
fence = edge;
} else if (edge[0] === fence[0] && edge.length >= fence.length) {
fence = null;
}
return true;
});
}
function trimBlankLines(lines) {
let start = 0;
let end = lines.length;
@@ -154,7 +181,7 @@ export function parseChangelogBody(bodyLines) {
if (current.bullets.length > 0) {
sections.push(current);
}
current = { bullets: [], title: stripChangelogMarkup(sectionMatch[1]) };
current = { bullets: [], title: stripChangelogMarkup(sectionMatch[1] ?? "") };
continue;
}