docs: explain that git-tag-version=false does not commit (#4574)

npm · Mar 17, 2022 · ddbb505 · ddbb505
1 parent 8ff1dfa
commit ddbb505
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/docs/content/commands/npm-version.md b/docs/content/commands/npm-version.md
@@ -52,7 +52,8 @@ Run git commit hooks when using the `npm version` command.
 * Default: true
 * Type: Boolean
 
-Tag the commit when using the `npm version` command.
+Tag the commit when using the `npm version` command. Setting this to false
+results in no commit being made at all.
 
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->

diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -677,7 +677,8 @@ but is not in the `PATH`, then set this to the full path to the git binary.
 * Default: true
 * Type: Boolean
 
-Tag the commit when using the `npm version` command.
+Tag the commit when using the `npm version` command. Setting this to false
+results in no commit being made at all.
 
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->

diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -798,7 +798,8 @@ define('git-tag-version', {
   default: true,
   type: Boolean,
   description: `
-    Tag the commit when using the \`npm version\` command.
+    Tag the commit when using the \`npm version\` command.  Setting this to
+    false results in no commit being made at all.
   `,
   flatten,
 })

diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -715,7 +715,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for git-t
 * Default: true
 * Type: Boolean
 
-Tag the commit when using the \`npm version\` command.
+Tag the commit when using the \`npm version\` command. Setting this to false
+results in no commit being made at all.
 `
 
 exports[`test/lib/utils/config/definitions.js TAP > config description for global 1`] = `

diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
@@ -551,7 +551,8 @@ but is not in the \`PATH\`, then set this to the full path to the git binary.
 * Default: true
 * Type: Boolean
 
-Tag the commit when using the \`npm version\` command.
+Tag the commit when using the \`npm version\` command. Setting this to false
+results in no commit being made at all.
 
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->