docs(version): add note about git version requirements #8812
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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 npm#2871
owlstronaut
approved these changes
Dec 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation about git version requirements for the npm version command.
Changes
Fixes
Closes #2871
Context
Users with older versions of git (such as git 1.9.1) encountered cryptic errors when using npm version because npm uses git command options that were not available in older versions (specifically --porcelain=v1).
The maintainer noted that the resolution should be to provide more clear docs/messaging for unsupported versions of dependencies.
While npm implicitly requires a modern version of git for its version command to work properly, this was not documented anywhere. This PR adds a simple note to help users understand this requirement and troubleshoot issues more easily.