Repository navigation
List v5 releases on the release notes overview - #817
Conversation
The overview at /release-notes labeled v4 Tucker as the current release. generateReleaseNotesData.js only matched X.Y.Z.md, but v5 notes are per minor (5.3.md) or assembled (5.4.generated.md), and the script ran before the assembler wrote the generated files. - Match X.Y.md and X.Y.generated.md as well as X.Y.Z.md. - Run prebuild.js after assemble-content.mjs in the pre* hooks. - Rewrite CONTRIBUTING's "Release Notes Process", which only covered v4, to say where 5.4+, 5.0-5.3 and v4 notes go. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
|
| "prestart": "node scripts/assemble-content.mjs && node scripts/prebuild.js", | ||
| "start": "docusaurus start", | ||
| "predev": "node scripts/prebuild.js && node scripts/assemble-content.mjs", | ||
| "predev": "node scripts/assemble-content.mjs && node scripts/prebuild.js", |
There was a problem hiding this comment.
This refreshes the release index at npm run dev startup. Subsequent local source edits go through scripts/assemble-content.mjs:317-329, which reassembles the pages without updating the JSON that the overview imports. In an in-memory run of the assembler and generator, I started with a local 5.4 note, removed its source, and invoked the watch callback. Assembly removed 5.4.generated.md, but the JSON still listed 5.4, leaving the overview pointed at a deleted page. Can you refresh the index after each successful watched assembly, and skip the write when the version list is unchanged?
| // Match version pattern in filename (e.g., "4.6.8.md") | ||
| const match = file.match(/^(\d+\.\d+\.\d+)\.md$/); | ||
| // Match "4.6.8.md", "5.3.md", or "5.4.generated.md" (assembled from harper and harper-pro) | ||
| const match = file.match(/^(\d+\.\d+(?:\.\d+)?)(?:\.generated)?\.md$/); |
There was a problem hiding this comment.
Adding v5 moves Tucker into the previous-major branch in src/components/ReleaseNotesList.tsx:57-68. I rendered the component with the base and head indexes and confirmed that “Meet Tucker” changes from /release-notes/v4-tucker/tucker to /release-notes/v4-tucker/. The new destination is the release summary, while Tucker’s profile is a separate page. Can the link keep pointing to the profile when v4 moves into the archive? Alby, Penny, and Monkey have their profiles on their index pages, so those destinations should stay as they are.
There was a problem hiding this comment.
Fixed in 2de8f95 and 8fb2258. The generator records hasProfilePage when the major has a <pup>.md or <pup>.mdx page, and the link uses it. Tucker links to /release-notes/v4-tucker/tucker again. Alby, Penny and Monkey still link to their index pages.
Drafted with Claude Opus 5.5 (my setup) and reviewed by me.
|
|
||
| ### 1. Create the Release Note File | ||
| - **5.4 and later:** write a fragment in `docs/release-notes/v5-lincoln/<minor>/` of harper or harper-pro, in the PR that makes the change. [`scripts/assemble-content.mjs`](scripts/assemble-content.mjs) combines the fragments into `release-notes/v5-lincoln/<minor>.generated.md` at build time; never edit or commit that file here. The fragment format is in [harper's docs/README.md](https://github.com/HarperFast/harper/blob/main/docs/README.md#release-notes). | ||
| - **5.0 to 5.3:** one file per minor in this repo, such as `release-notes/v5-lincoln/5.3.md`. Patch releases are described in [GitHub releases](https://github.com/HarperFast/harper/releases), not here. |
There was a problem hiding this comment.
The last sentence says patch releases are described only on GitHub, but the checked-in minor pages also include patch highlights. For example, release-notes/v5-lincoln/5.3.md:72-74 describes a 5.3.1 change, and release-notes/v5-lincoln/5.2.md:49-55 describes 5.2.3 changes. Could you say GitHub carries the full per-patch release notes and the site groups selected changes on each minor page?
…view - Link "Meet <pup>" to the pup's own page when the major has one, so Tucker still links to his profile now that v4 is a previous major. - Regenerate release-notes-data.json after each reassembly in `npm run dev`, and skip the write when nothing changed. - Say in CONTRIBUTING that minor pages also highlight patch changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Dispatch-Task: fix-Ethan-Arrowood_documentation_817-441b1ce7
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Dispatch-Task: fix-Ethan-Arrowood_documentation_817-441b1ce7
⊙ Problem
https://docs.harper.fast/release-notes labels v4 Tucker as the current release and lists no v5 versions.
scripts/generateReleaseNotesData.jsonly matchesX.Y.Z.md, but v5 notes are per minor (5.3.md) or assembled from harper and harper-pro (5.4.generated.md). The script also ran before the assembler wrote the generated files.CONTRIBUTING's "Release Notes Process" only describes v4 per-patch files.
💡 Solution
X.Y.mdandX.Y.generated.mdas well asX.Y.Z.md.prebuild.jsafterassemble-content.mjsin theprebuild,predevandprestarthooks.✅ Verification
npm run buildpasses. The built/release-notespage shows "Current Release - Version 5 (Lincoln)" with 5.5 down to 5.0, and the older majors are unchanged.format:checkandlintpass.Drafted with Claude Opus 5.5 (my setup) and reviewed by me.
Complexity: easy
Review-Coverage: authored=claude; ran=gemini,cursor-composer,codex,gemini-carbon; late=gemini-carbon:adjudicated; adjudicated=domain; declined=cursor-grok,muse; rounds=2; full=1 @ 8fb2258
Review-Attention: read ~3m (decisions: profile-detection-by-fs-probe, dev-regen-in-assembler, contributing-drops-v4-walkthrough) @ 8fb2258