Skip to content

Commit dd104da

Browse files
Max Blackowlstronaut
authored andcommitted
docs(version): add note about git version requirements
- Add note that git 2.0.0 or later is recommended for npm version - Helps users troubleshoot issues with older git versions - Addresses feedback from issue about cryptic errors with git 1.9 Fixes #2871
1 parent 58afdcc commit dd104da

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/lib/content/commands/npm-version.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ If run in a git repo, it will also create a version commit and tag.
2727
This behavior is controlled by `git-tag-version` (see below), and can be disabled on the command line by running `npm --no-git-tag-version version`.
2828
It will fail if the working directory is not clean, unless the `-f` or `--force` flag is set.
2929

30+
**Note:** Git integration requires a reasonably recent version of git (2.0.0 or later is recommended). If you encounter issues with git commands, ensure your git installation is up to date.
31+
3032
If supplied with `-m` or [`--message` config](/using-npm/config#message) option, npm will use it as a commit message when creating a version commit.
3133
If the `message` config contains `%s` then that will be replaced with the resulting version number.
3234
For example:

0 commit comments

Comments
 (0)