feat: render the Ordo changelog as a docs page - #36
Open
synchwire wants to merge 2 commits into
Open
Conversation
The changelog is generated in the ordo repository by git-cliff and now ships in the reference bundle, so the release sync writes it here as src/content/docs/changelog.md — the same treatment the CLI reference Markdown gets, with frontmatter prepended. The page is committed alongside the sidebar entry because Starlight fails the build when a sidebar slug has no matching entry, so the navigation line cannot land before the first sync. Later syncs overwrite the file.
✅ Deploy Preview for ordo-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ordo now generates
CHANGELOG.mdwith git-cliff and ships it in the reference bundle. The release sync writes it here as a Starlight page, so operators have a changelog — theordorepository and its releases are private, so its ownCHANGELOG.mdis not a surface they can read.src/content/docs/changelog.md— the page, in the form the sync produces: frontmatter prepended, generated H1 dropped, do-not-edit marker. Overwritten on each release sync.astro.config.mjs— sidebar entry, above Architecture.Why the page is committed rather than left to the sync
Starlight fails the build with
The slug "changelog" specified in the Starlight sidebar config does not existwhen a sidebar entry has no matching content entry. So the navigation line cannot land before the first sync writes the file. Committing both together keeps the build green at every point, and the sync overwrites the file from then on.Verified with
npm run build: 101 pages,/changelog/rendered with the v0.1.0 section and sidebar entry present.Paired with the ordo-side change that adds git-cliff,
cliff.toml, and the bundle artifact.