Skip to content

cli: copy the README before publishing to npm - #871

Merged
ualtinok merged 1 commit into
cortexkit:masterfrom
trim21:fix/cli-publish-readme
Nov 7, 2026
Merged

ualtinok merged 1 commit into
cortexkit:masterfrom
trim21:fix/cli-publish-readme

Conversation

@trim21

@trim21 trim21 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Refs #850 (this PR does not close it — the issue closes with the release).

publish-npm-cli builds and publishes packages/cli without ever creating packages/cli/README.md. files lists README.md, but npm silently skips missing entries, so @cortexkit/magic-context ships with no README and the npm page shows "No README data found!" (confirmed on 0.49.37: npm view @cortexkit/magic-context readme errors).

This mirrors what publish-npm already does for @cortexkit/opencode-magic-context: copy the repo README into the package right before npm publish.

Verification

Simulated the step locally (cp README.md packages/cli/README.md + npm pack --dry-run --json) — the tarball now contains README.md:

"files": [
  { "path": "README.md", "size": 34931, "mode": 420 },
  { "path": "package.json", "size": 1772, "mode": 420 }
]

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.

RetriggerView in GreptileConfidence Score: 5/5

This PR appears safe to merge.

Summary

Copies the root README.md into packages/cli before publishing to npm.

  • The CLI package now ships its README with npm releases.

Reviews (2) · Last reviewed commit: "cli: copy the README before publishing t..." · Reviewed by Greptile

@github-actions

github-actions Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

#850 has the design-approved label; this PR can be reviewed.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

View guided diff | Re-trigger cubic

@magic-alfonso

magic-alfonso Bot commented Nov 6, 2026

Copy link
Copy Markdown

Thanks, this is the right fix: the CLI package lists README.md in files, but the publish job never put one there.

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
@trim21
trim21 force-pushed the fix/cli-publish-readme branch from 731df7e to 32c8cb9 Compare November 7, 2026 07:30
@trim21

trim21 commented Nov 7, 2026

Copy link
Copy Markdown
Contributor Author

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.

@ualtinok
ualtinok merged commit bac7f30 into cortexkit:master Nov 7, 2026
16 of 18 checks passed
@magic-alfonso

magic-alfonso Bot commented Nov 7, 2026

Copy link
Copy Markdown

Merged, thanks. The README appears on npm with the next release of @cortexkit/magic-context, and I'll close issue 850 then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants