Repository navigation
ci: write the docs changelog from changesets - #145
Merged
Merged
Conversation
… the docs changelog
Each changeset carries its docs changelog entry in English and Turkish in a <!-- docs --> block. version-packages writes them into changelog.mdx and changelog.tr.mdx, and CI checks that every changeset has one.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Oct 7, 2026
This branch was successfully deployed
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
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.
Builds on #144; merge that first (until then this PR also shows its commit).
Before: the docs changelog (
changelog.mdx/changelog.tr.mdx) was written by hand in the release PR. When it was forgotten, as in 0.8.0, Publish to NPM stopped.After: each changeset carries its docs changelog entry in English and Turkish, and
pnpm version-packageswrites the new version's section into both pages, so the release PR already has it:Entries are grouped under Added (minor), Fixed (patch) or Changed (breaking) (major); an optional
section:line picks another (changed-breakingfor breaking changes in 0.x). A new CI step fails a PR whose changeset has no entry. A changeset without one still releases: its summary is used on both pages.How:
scripts/docs-changelog.mjsparses the block and builds the section;version-packages.mjsreads the changesets beforechangeset versiondeletes them, inserts the sections and runscheck-translations.mjs --fixfor the Turkish heading ids;.changeset/changelog.cjsleaves the block out of CHANGELOG.md;scripts/check-changesets.mjsruns in CI. Tested end to end in a scratch checkout with three changesets (with a block, withsection: changed-breaking, without a block); the translation check passed on the result. CONTRIBUTING (en/tr) describes the format.