Skip to content

Include README and LICENSE in published npm packages - #45

Merged
austin-smith merged 2 commits into
mainfrom
npm-package-readme-license
Aug 14, 2026
Merged

austin-smith merged 2 commits into
mainfrom
npm-package-readme-license

Conversation

@austin-smith

Copy link
Copy Markdown
Owner

Published npm tarballs are packed from a staging directory that only received the binaries, so they contained no README or LICENSE and npmjs.com showed "This package does not have a README."

  • Copy README.md and LICENSE from the repo root into every staged package (root and platform) before npm pack runs
  • Bump the version to 0.2.2, since 0.2.1 is already published and npm does not allow republishing an existing version

Validation: bun run typecheck, bun test (1085 pass), licenses:generate/licenses:check (notices unchanged), and a local root-package build confirming the tarball contains README.md, LICENSE, package.json, and bin/spotuify.cjs.

npm packages are packed from a staging directory that only received
the binaries, so published tarballs had no readme or license file and
npmjs.com showed an empty readme. bump to 0.2.2 since 0.2.1 is already
published and cannot be replaced.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

馃挕 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0431c2bc5b

鈩癸笍 About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 馃憤.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread scripts/package-npm.ts
the verifier requires exact tarball file lists and still expected only
binaries and package.json, failing the release smoke tests now that
packaging includes readme and license files.
@austin-smith

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. More of your lovely PRs please.

Reviewed commit: 7305349c59

鈩癸笍 About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 馃憤.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@austin-smith
austin-smith merged commit 4ef3a3f into main Aug 14, 2026
5 checks passed
@austin-smith
austin-smith deleted the npm-package-readme-license branch August 14, 2026 01:13
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.

1 participant