Skip to content

Commit 77a5748

Browse files
committed
docs: update README to list bad Git versions
Add a section to the README document that lists versions of Git that GCM is known to have problems with, such as 2.26.2 that broke credential configuration parsing.
1 parent 613d894 commit 77a5748

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,22 @@ repositories from inside of WSL.
173173

174174
[Please see the GCM Core on WSL docs](docs/wsl.md) for more information.
175175

176+
## Supported Git versions
177+
178+
Git Credential Manager Core tries to be compatible with the broadest set of Git
179+
versions (within reason). However there are some know problematic releases of
180+
Git that are not compatible.
181+
182+
- Git 1.x
183+
184+
The initial major version of Git is not supported or tested with GCM.
185+
186+
- Git 2.26.2
187+
188+
This version of Git introduced a breaking change with parsing credential
189+
configuration that GCM relies on. This issue was fixed in commit [`12294990`](https://github.com/git/git/commit/12294990c90e043862be9eb7eb22c3784b526340)
190+
of the Git project, and released in Git 2.27.0.
191+
176192
## How to use
177193

178194
Once it's installed and configured, Git Credential Manager Core is called implicitly by Git.

0 commit comments

Comments
 (0)