Repository navigation
cli: copy the README before publishing to npm - #871
Conversation
|
#850 has the |
|
Thanks, this is the right fix: the CLI package lists One change before merge: please remove "Fixes #850" from the commit message and the PR description. Pushing a commit with a closing keyword to master closes the issue before the release ships, so our merge script refuses it. Write "issue 850" instead, then amend and force-push. I'll merge once the checks are green, and the issue gets closed with the release. |
publish-npm-cli never created packages/cli/README.md, and npm silently skips a missing files entry, so @cortexkit/magic-context published with no README and npm shows "No README data found". Mirror publish-npm and copy the repo README into the package right before npm publish. Refs cortexkit#850
731df7e to
32c8cb9
Compare
|
Done: commit amended to reference "issue 850" (no closing keyword) and force-pushed as 32c8cb9; PR description updated the same way. Checks are re-running on the new head. |
|
Merged, thanks. The README appears on npm with the next release of |
Refs #850 (this PR does not close it — the issue closes with the release).
publish-npm-clibuilds and publishespackages/cliwithout ever creatingpackages/cli/README.md.fileslistsREADME.md, but npm silently skips missing entries, so@cortexkit/magic-contextships with no README and the npm page shows "No README data found!" (confirmed on 0.49.37:npm view @cortexkit/magic-context readmeerrors).This mirrors what
publish-npmalready does for@cortexkit/opencode-magic-context: copy the repo README into the package right beforenpm publish.Verification
Simulated the step locally (
cp README.md packages/cli/README.md+npm pack --dry-run --json) — the tarball now containsREADME.md:Also ran
bun test packages/e2e-tests/scripts/ci-workflow.test.ts(13 pass), which parses both workflows.Note: npm captures the README at publish time, so the npm page only updates from the next release onward.


Confidence Score: 5/5
This PR appears safe to merge.Summary
Copies the root
README.mdintopackages/clibefore publishing to npm.Reviews (2) · Last reviewed commit: "cli: copy the README before publishing t..." · Reviewed by Greptile