From 96e420ffaf6045d846709b2db89d26292f69e720 Mon Sep 17 00:00:00 2001 From: Matthew John Cheetham Date: Tue, 12 Oct 2021 14:31:35 +0100 Subject: [PATCH] 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. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4ddce3a07f..ea08eb9f7a 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,23 @@ repositories from inside of WSL. [Please see the GCM Core on WSL docs](docs/wsl.md) for more information. +## Supported Git versions + +Git Credential Manager Core tries to be compatible with the broadest set of Git +versions (within reason). However there are some know problematic releases of +Git that are not compatible. + +- Git 1.x + + The initial major version of Git is not supported, or tested with GCM. + +- Git 2.26.2 + + This version of Git introduced a breaking change with parsing credential + configuration that GCM relies on. This issue was fixed in commit + [`12294990c90e043862be9eb7eb22c3784b526340`](https://github.com/git/git/commit/12294990c90e043862be9eb7eb22c3784b526340) of the Git project, and released in + Git 2.27.0 + ## How to use Once it's installed and configured, Git Credential Manager Core is called implicitly by Git.