Repository navigation
docs: clarify staged publishing can create new packages - #2047
Merged
Merged
Conversation
Update the staged publishing prerequisites to note that a package does not need to already exist on the npm registry. Staging a brand-new package creates it when the staged version is approved. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Clarify that staged publishing can create new packages and works for existing ones. Add requirements for npm CLI and Node versions.
shmam
added a commit
to npm/cli
that referenced
this pull request
Sep 24, 2026
#10017) ## Summary The `npm stage` **Prerequisites** section states that the package must already exist on the npm registry. Staged publishing will soon support **creating brand-new packages** via staged publishing. This updates the prerequisite docs accordingly. ## Changes - `docs/lib/content/commands/npm-stage.md` — replaced the "Package must exist" prerequisite with "New or existing packages," clarifying that a package does not need to pre-exist and that approving a staged brand-new package creates it. ## Related Companion docs change in npm/documentation: npm/documentation#2047 (the generated `content/cli/*/commands/npm-stage.mdx` pages are synced from this file via the `update-cli` workflow). --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
shmam
commented
Sep 29, 2026
shmam
left a comment
shmam
left a comment
Contributor
Author
There was a problem hiding this comment.
slight suggestions to emphasize placeholder is a version not a new package
Co-authored-by: sam crochet <shmam@github.com>
karenjli
approved these changes
Sep 29, 2026
A prior format commit reformatted the auto-generated content/cli/v11 and v12 npm-stage.mdx files (aligning markdown tables) and regenerated package-lock.json. The generated CLI docs must match the npm/cli generator output exactly, so the Check CLI Documentation CI step failed. Restore these files to their pre-format state, keeping only the intended hand-authored documentation changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
The content/cli docs are generated from the npm/cli repo via the update-cli workflow and must match the generator output exactly, which uses compact Markdown table separators that Prettier would reflow. Running prettier --write on them breaks the Check CLI Documentation step, while leaving them raw breaks Check Format. Ignore content/cli in Prettier (as cli-cache.json already is) so both checks pass. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This branch was successfully deployed
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
Clarifies that staged publishing can soon be used to create brand-new packages, not just stage new versions of packages that already exist on the registry.
Changes
content/packages-and-modules/securing-your-code/staged-publishing.mdx— updated the Prerequisites bullet to reflect that a package can be brand-new or already published.Companion PR
The
npm stageCLI reference pages (content/cli/v11andv12) carry the same "Package must exist" prerequisite, but those files are auto-generated from thenpm/clirepo (docs/lib/content/commands/npm-stage.md) via theupdate-cliworkflow. The matching fix is in npm/cli#10017 so the correction isn't overwritten on the next sync.