docs: add a generated root changelog merged from the package changelogs - #389
Open
Kyleasmth wants to merge 2 commits into
Open
docs: add a generated root changelog merged from the package changelogs#389Kyleasmth wants to merge 2 commits into
Kyleasmth wants to merge 2 commits into
Conversation
🦋 Changeset detectedLatest commit: 69d85e4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Kyleasmth
marked this pull request as ready for review
September 10, 2026 20:20
…k line splitting an entry
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.
Closes YPE-5752. The research half, YPE-4190, is closed: Jeff confirmed on 10 Sep that React and RN Expo are in scope and should match the Swift pattern.
Swift and Kotlin each ship a root
CHANGELOG.md. This repo had only per-package files, so there was no single place to see what shipped in a release. This adds one, generated rather than maintained by hand.Why it is generated and deduped
The three packages are a
fixedgroup in.changeset/config.json, so they always share a version, and a changeset touching several of them writes the same entry into each of their changelogs. Concatenating the three would triple most entries:Each entry is shown once and annotated with which packages it affected —
_(all packages)_, or the specific ones. Across the history that splits 91 all-package, 47 ui-only, 12 hooks+ui, 8 hooks-only, 7 core-only, so the annotation carries real information rather than decorating every line identically.Updated dependenciesblocks are dropped. They are the fixed group's internal bookkeeping (@youversion/platform-core@2.12.1etc.) and not something a consumer reading release notes needs.Staying current
version-packagesbecomeschangeset version && node scripts/build-root-changelog.mjs.changesets/actionalready invokes it viaversion: pnpm version-packages, so the "Version Packages" PR carries an up-to-date root changelog with no workflow change. Also exposed aspnpm build:root-changelog.Verified
.prettierignoreexcludes*.mdregardless.Scope note
RN Expo has the same gap (
coreanduichangelogs, no root) and is deliberately not included here. It is the second half of YPE-5752 and is near-identical work once this shape is agreed.Greptile Summary
This PR adds a generated repository-level changelog assembled from the three fixed-group package changelogs and integrates regeneration into the Changesets version command.
CHANGELOG.mdwith package-scope annotations.build:root-changelogand runs it afterchangeset version.Confidence Score: 5/5
The PR appears safe to merge because no blocking failure remains.
No blocking failure remains.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart LR Core[Core package changelog] --> Generator[build-root-changelog.mjs] Hooks[Hooks package changelog] --> Generator UI[UI package changelog] --> Generator Generator --> Root[Root CHANGELOG.md] Changesets[changeset version] --> Generator Root --> VersionPR[Version Packages PR]Reviews (2): Last reviewed commit: "fix: drop the fixed group's version book..." | Re-trigger Greptile
Context used: