Skip to content

Commit ddbb505

Browse files
authored
docs: explain that git-tag-version=false does not commit (#4574)
1 parent 8ff1dfa commit ddbb505

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

docs/content/commands/npm-version.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ Run git commit hooks when using the `npm version` command.
5252
* Default: true
5353
* Type: Boolean
5454

55-
Tag the commit when using the `npm version` command.
55+
Tag the commit when using the `npm version` command. Setting this to false
56+
results in no commit being made at all.
5657

5758
<!-- automatically generated, do not edit manually -->
5859
<!-- see lib/utils/config/definitions.js -->

docs/content/using-npm/config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,8 @@ but is not in the `PATH`, then set this to the full path to the git binary.
677677
* Default: true
678678
* Type: Boolean
679679

680-
Tag the commit when using the `npm version` command.
680+
Tag the commit when using the `npm version` command. Setting this to false
681+
results in no commit being made at all.
681682

682683
<!-- automatically generated, do not edit manually -->
683684
<!-- see lib/utils/config/definitions.js -->

lib/utils/config/definitions.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,8 @@ define('git-tag-version', {
798798
default: true,
799799
type: Boolean,
800800
description: `
801-
Tag the commit when using the \`npm version\` command.
801+
Tag the commit when using the \`npm version\` command. Setting this to
802+
false results in no commit being made at all.
802803
`,
803804
flatten,
804805
})

tap-snapshots/test/lib/utils/config/definitions.js.test.cjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for git-t
715715
* Default: true
716716
* Type: Boolean
717717
718-
Tag the commit when using the \`npm version\` command.
718+
Tag the commit when using the \`npm version\` command. Setting this to false
719+
results in no commit being made at all.
719720
`
720721

721722
exports[`test/lib/utils/config/definitions.js TAP > config description for global 1`] = `

tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,8 @@ but is not in the \`PATH\`, then set this to the full path to the git binary.
551551
* Default: true
552552
* Type: Boolean
553553
554-
Tag the commit when using the \`npm version\` command.
554+
Tag the commit when using the \`npm version\` command. Setting this to false
555+
results in no commit being made at all.
555556
556557
<!-- automatically generated, do not edit manually -->
557558
<!-- see lib/utils/config/definitions.js -->

0 commit comments

Comments
 (0)