Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/content/commands/npm-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
3 changes: 2 additions & 1 deletion docs/content/using-npm/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
3 changes: 2 additions & 1 deletion lib/utils/config/definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
})
Expand Down
3 changes: 2 additions & 1 deletion tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`] = `
Expand Down
3 changes: 2 additions & 1 deletion tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down