fix(cli): correct the package README, which said the package was unpublished (0.5.2) - #17
Merged
Merged
Conversation
…blished `packages/cli/README.md` is listed in `files`, so it ships in the tarball and renders on the npm package page. It still carried the pre-release notice — "Not yet published. This package is not on npm… Do not document `npm install @workspacejson/cli` as if it works" — so the page for a published package was advising against installing it and redirecting to `agents-audit`. I missed it when updating the publishing docs: I fixed the root README and the changelog and never checked the per-package README, which is the one users actually see. Replaced with install instructions, a note that releases carry npm provenance, and a migration table for anyone arriving from `agents-audit` — renamed binary, no `scan`, `.agentsauditrc` not read. Cut as 0.5.2. A README-only change still needs a release, because the text on the npm page updates only on publish. Verified: architecture guard, 108 tests, and the packed tarball carries the corrected README.
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
packages/cli/README.mdis listed infiles, so it ships in the tarball and renders on the npm package page. It still carried the pre-release notice:So the page for a published package was telling people not to install it, and redirecting them to
agents-audit— which is frozen.I missed this when updating the publishing docs in #14: I fixed the root
README.mdand the changelog and never checked the per-package README, which is the one users actually see.Changes
agents-audit: renamed binary, noscan,.agentsauditrcnot readCut as 0.5.2 through the changeset flow. A README-only change still needs a release — the npm page updates only on publish.
Verification
pnpm run check:architecturepnpm -r buildpnpm -r test— 108 testspnpm run release:verify-packs— packed tarball carries the corrected README (3.0kB)Notes
Release after merge:
git tag cli-v0.5.2 && git push --tags.agents-audit's own README is untouched — it is frozen at0.4.4, so its npm page cannot be updated regardless. It documentsnpm install -D agents-audit, which is accurate for that package.