Skip to content

fix(packaging): include README in published npm and lib crate#121

Merged
emal-avala merged 1 commit intomainfrom
fix/published-package-readmes
Apr 15, 2026
Merged

fix(packaging): include README in published npm and lib crate#121
emal-avala merged 1 commit intomainfrom
fix/published-package-readmes

Conversation

@emal-avala
Copy link
Copy Markdown
Member

Discovered while auditing the v0.15.1 release artifacts.

Issues fixed

  1. npm package on the registry has no README. npm/package.json had a strict files allowlist that excluded README.md, so the published tarball was missing it (verified via the registry API: readme present: False). Added README.md to files.
  2. npm README install command was wrong. It said npm install -g agent-code but the package is published as @avala-ai/agent-code. Fixed.
  3. agent-code-lib on crates.io has no README (the CLI crate already has one via readme = "../../README.md"). Added the same field to crates/lib/Cargo.toml.
  4. Cosmetic: npm/package.json version stub was still 0.14.0. The release workflow overrides at publish time so this never actually shipped wrong, but bumped to 0.15.1 to match reality.

Test plan

  • Next release: confirm @avala-ai/agent-code page on npmjs.com renders README
  • Next release: confirm crates.io/crates/agent-code-lib has the README rendered

- npm/package.json: add README.md to files allowlist; bump version stub to 0.15.1
- npm/README.md: correct install command to scoped @avala-ai/agent-code
- crates/lib/Cargo.toml: point readme at root README so agent-code-lib has a docs page on crates.io
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@emal-avala emal-avala merged commit 2d8a65f into main Apr 15, 2026
13 of 14 checks passed
@emal-avala emal-avala deleted the fix/published-package-readmes branch April 15, 2026 07:54
emal-avala added a commit that referenced this pull request Apr 15, 2026
Patch release with the packaging fixes from #121:
- npm package now ships README and uses correct scoped install command
- agent-code-lib has a README on crates.io
- npm/package.json version stub aligned
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