fix(cli): include README in published npm package#4
Merged
Conversation
- Add copy:readme script that copies root README into packages/cli - Hook it into prepublishOnly (local publish path) - Also copy in CI workflow before publish (defense-in-depth) - Gitignore packages/cli/README.md so single source of truth stays at repo root Fixes empty README on npmjs.com/package/f2u-cli
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
Why
Current npm tarball ships only 3 files (no README) → package page on npmjs.com is blank. Dry-run `npm pack` now shows:
```
README.md 8.4 kB
dist/index.d.ts 13 B
dist/index.js 10.7 kB
package.json 672 B
total files: 4
```
Test plan
Note on prior publish failure
Run #24450658992 failed with 404 on `PUT /f2u-cli` — likely an `NPM_TOKEN` scope issue, not the README problem. See separate diagnosis message.