docs(release): document the npm wrapper publish step in the v1.0.0 checklist#36
Merged
Merged
Conversation
…ecklist Fills the gap left after #34 shipped the wrapper source into nodeup-npm/. The wrapper now exists on a clean install-from-tarball path, but publishing it to the npmjs.com registry is a manual step that's distinct from the GitHub release flow: - npmjs.com account + 2FA (authenticator mode) prereq - the v1.0.0 GitHub release has to exist before `npm publish`, because scripts/install.js fetches from the matching tag - the publish flow with OTP prompt and a `npm pack --dry-run` pre-flight to confirm only the 5 expected files ship - a note on automating later via NPM_TOKEN, after the first manual publish has confirmed the account + package name wiring Tracking issue: #35. Co-Authored-By: Sonnet 4.6 <noreply@puku.sh>
|
✔️ 29c7105 - Conventional commits check succeeded. |
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
Adds the npm-publish step to
docs/release-checklist.md's post-tagsection, with the prerequisites, the exact commands, and a note on
automating later. Tracks the manual work in #35 — it's a release-time
step, not a code PR, so it doesn't block any of the open issues.
The wrapper source itself shipped in #34 (
nodeup-npm/in therepo). What this PR adds is the human-side checklist for
shipping it to npmjs.com.
Linked issues
Refs #35 (tracking issue for the manual publish step at v1.0.0 cut)
Type of change
feat— new feature (MINOR bump)fix— bug fix (PATCH bump)refactor— no behavior changedocs— documentation onlychore— maintenance / dependency bumpci— CI/CD onlybuild— build system onlyChecklist
docs(release): subject)make cilocally — docs-only, no code changeScope notes / things reviewers may want to look at
npm pack --dry-runfromnodeup-npm/after the chore(release): ship npm wrapper and install-method guidance #34 merge and confirmed the tarball shipsexactly the 5 expected files:
LICENSE,README.md,package.json,scripts/check.js,scripts/install.js. Totalunpacked 14.3 kB. The
.npmignoreis doing its job — nobin/,no
.npmignoreitself, nonode_modules.nodeuphas to be claimed on npmjs.combefore any publish can succeed, and that claim is a one-time
manual step in the npm UI.
npm publishagainst a 2FA-enabled account is themoment to sanity-check what you're shipping — once you've got
the workflow trust chain, automation is fine, but the first
click is best done by hand.
npm logindoesn't askfor OTP, but
npm publishdoes. Keep the authenticator open.Screenshots / output