chore: rename npm package to @volcano.dev/cli#36
Conversation
Publish under the @volcano.dev/cli scope to match the target npm package name. Only the npm package name changes; the volcano bin command, repository.url (github.com/Kong/volcano-cli, required for trusted publishing), and public access are unchanged.
There was a problem hiding this comment.
Pull request overview
This PR renames the published npm package from @kong/volcano-cli to @volcano.dev/cli to align with the intended npm publishing scope. The npm package itself is a thin wrapper whose postinstall step fetches the platform-specific Go binary from GitHub Releases, so this rename affects only the install/identity of the wrapper, not the CLI functionality.
I verified that no stale @kong/volcano-cli references remain, that the publish workflow (.github/workflows/publish-cli.yml) reads the name dynamically from package.json via npm publish (no hardcoded name to update), and that the intentionally-unchanged repository.url, bin, and trusted-publisher config remain consistent. The PR description's open question about dotted scopes checks out: npm currently permits dotted scopes (e.g., @volcano.dev/cli), so the new name is valid and registerable.
Changes:
- Update
package.jsonnamefield to@volcano.dev/cli. - Update the README npm install command to
npm install -g @volcano.dev/cli.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Renames the name field to the new @volcano.dev/cli scope. |
| README.md | Updates the documented npm install command to the new package name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Renames the npm package from
@kong/volcano-clito@volcano.dev/cliso it matches the target npm scope we publish under.Changes
package.json—name: @volcano.dev/cliREADME.md— install command →npm install -g @volcano.dev/cliUnchanged (intentionally)
repository.urlstaysgit+https://github.com/Kong/volcano-cli.git— it must match the GitHub repo for npm trusted publishing, and is independent of the package name.binstaysvolcano— the installed command name is unaffected.publishConfig.access: public,homepage, andbugs(GitHub repo) unchanged.Kong, repovolcano-cli, workflowpublish-cli.yml).Verification
package.jsonvalid; name reflected innpm pack --dry-run(volcano.dev-cli-0.0.0.tgz, 6 files, ~10 kB)@kong/volcano-clireferences remainNote
Publishing requires the
@volcano.devscope (npm org/user) to exist and the publisher to have write access. Worth confirming the org is registerable on npmjs.com — npm organization names have historically been restricted to lowercase letters, numbers, and hyphens, so please verify a dotted scope (volcano.dev) is accepted before the bootstrap publish.