diff --git a/docs/content/commands/npm-version.md b/docs/content/commands/npm-version.md index b53dd64aeae85..86e2ce90e9bea 100644 --- 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. diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md index 9fbb614564df8..b2e60a742a054 100644 --- 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. diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js index c5c129eb3d495..42795f1b6b8b9 100644 --- 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 index d75d32d9b74ea..6bb988d604aa1 100644 --- 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 index 27b8278fd388e..e4357158d0701 100644 --- 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.