build(readme): sync only shared blocks so packages keep their own READMEs - #83
Closed
apresmoi wants to merge 1 commit into
Closed
build(readme): sync only shared blocks so packages keep their own READMEs#83apresmoi wants to merge 1 commit into
apresmoi wants to merge 1 commit into
Conversation
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.
Summary
sync-package-readmes.mjswith a partial sync: only regions wrapped in<!-- polycss:shared:<name>:start/end -->are mirrored from the root README, and everything between them is package-specificlinks,packages,showcase,license— and adopt them in thecore,polycss,react, andvueREADMEscoredocumented the wrong package (it told readers tonpm install @layoutit/polycssand showed JSX), andvueshipped React TSX examplesfontsandmorphneed no exemption list and are left untouchedpnpm check:readmes(--check) and run it in CI, so a shared block edited in the wrong place fails the build instead of driftingAGENTS.mdand add a PR-checklist linePreviously
prepackcopied the root README over all four packages on everynpm pack/npm publish, so a package-specific README could not reach npm — the file reviewed in a PR was not the file published. Now what is committed is what ships.Validation
pnpm testpnpm build:packagespnpm check:readmesnpm pack --dry-runinpackages/core:prepackreports0 READMEs updated, and the tarball carries core's own 5.9 kB README rather than the 9.9 kB root copy--checkwith a non-zero exit, and passes again once restored