Repository navigation
fix: include README and LICENSE in the published package - #267
Merged
Merged
Conversation
Copy the repository root README.md and LICENSE into packages/router on prepack so they are included in the npm tarball. The hero image in the README now uses an absolute URL so it renders on npmjs.com. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XzEsqHjb7nDGfaePZYkyYk
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
2 participants
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
The
@funstack/routernpm package didn't include a README (or LICENSE). Both files live at the repository root, but npm only picks them up from the package directory (packages/router).prepackscript topackages/routerthat copies the rootREADME.mdandLICENSEinto the package directory.pnpm publishrunsprepackautomatically, sopublish.ymldoesn't need any changes.packages/router/.gitignore.raw.githubusercontent.comURL so it renders on npmjs.com. The relative path wouldn't load there because the image isn't in the package.Test plan
pnpm packinpackages/routerproduces a tarball containingREADME.mdandLICENSEpnpm format:checkpasses🤖 Generated with Claude Code
https://claude.ai/code/session_01XzEsqHjb7nDGfaePZYkyYk
Generated by Claude Code