File tree Expand file tree Collapse file tree 1 file changed +15
-1
lines changed
Expand file tree Collapse file tree 1 file changed +15
-1
lines changed Original file line number Diff line number Diff line change 22
33## Releasing
44
5- From a clean working copy, run ` npm version major|minor|patch|VERSION ` .
5+ From a clean working copy, run [ ` npm version major|minor|patch|VERSION ` ] [ npm-version ] .
66This will bump the package version, commit, tag, and push.
77The tag-push event triggers the release workflow on GitHub.
88The workflow creates a GitHub Release from the tag and publishes to npm.
9+
10+ It is preferred for these version commits and tags to be signed by git. This
11+ not only aids with provenance, but the act of signing the tag also ensures
12+ these release tags are [ annotated tags] [ ] , not [ lightweight tags] [ ] . First be
13+ sure git is [ configured for signing] [ git signing ] . Then either tell git to
14+ sign _ all_ tags with [ ` tag.gpgSign = true ` ] [ tag.gpgSign ] (recommended), or
15+ configure npm to sign its tags with [ ` sign-git-tag = true ` ] [ sign-git-tag ] .
16+
17+ [ npm-version ] : https://docs.npmjs.com/cli/v11/commands/npm-version
18+ [ annotated tags ] : https://git-scm.com/book/en/v2/Git-Basics-Tagging#_annotated_tags
19+ [ lightweight tags ] : https://git-scm.com/book/en/v2/Git-Basics-Tagging#_lightweight_tags
20+ [ git signing ] : https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work
21+ [ tag.gpgSign ] : https://git-scm.com/docs/git-config#Documentation/git-config.txt-taggpgSign
22+ [ sign-git-tag ] : https://docs.npmjs.com/cli/v11/using-npm/config#sign-git-tag
You can’t perform that action at this time.
0 commit comments