Merge pull request #530 from microsoft/main

New release

Author: mjcheetham

.github/ISSUE_TEMPLATE/auth-problem.md

@@ -8,7 +8,7 @@ assignees: ''
 
 **Which version of GCM Core are you using?**
 
-From a terminal, run `git-credential-manager-core --version` and paste the output.
+From a terminal, run `git credential-manager-core --version` and paste the output.
 
 <!-- Ex:
 Git Credential Manager version 2.0.8-beta+e1f8492d04 (macOS, .NET Core 4.6.27129.04)

.github/workflows/release-apt-get.yml

@@ -7,7 +7,7 @@
 
 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
 
-Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
 
 Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
 
@@ -24,6 +24,11 @@ This helps us coordinate and reduce duplication.
 0. Make sure the tests pass on your machine: `dotnet test`
 0. Create a new branch: `git switch -c my-branch-name`
 0. Make your change, add tests, and make sure the tests still pass
+0. For UI updates, test your changes by executing a `dotnet run` in applicable UI-related project directories:
+    - `Atlassian.Bitbucket.UI.Avalonia`
+    - `GitHub.UI.Avalonia`
+    - `Atlassian.Bitbucket.UI.Windows`
+    - `GitHub.UI.Windows`
 0. Push to your fork and [submit a pull request][pr]
 0. Pat your self on the back and wait for your pull request to be reviewed and merged.
 

.github/workflows/release-winget.yaml

@@ -7,9 +7,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A7FC1234-95E
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Git-Credential-Manager", "src\shared\Git-Credential-Manager\Git-Credential-Manager.csproj", "{28F06D44-AB25-4CF5-93F9-978C23FAA9D6}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Git.CredentialManager", "src\shared\Microsoft.Git.CredentialManager\Microsoft.Git.CredentialManager.csproj", "{31BCFC70-B767-4274-873F-1A076D422FC3}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Core", "src\shared\Core\Core.csproj", "{31BCFC70-B767-4274-873F-1A076D422FC3}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Git.CredentialManager.Tests", "src\shared\Microsoft.Git.CredentialManager.Tests\Microsoft.Git.CredentialManager.Tests.csproj", "{AD41FA1E-51F5-4E4F-B7DA-32F921491313}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Core.Tests", "src\shared\Core.Tests\Core.Tests.csproj", "{AD41FA1E-51F5-4E4F-B7DA-32F921491313}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AzureRepos", "src\shared\Microsoft.AzureRepos\Microsoft.AzureRepos.csproj", "{714AF9EB-44E6-4058-BD3E-9039F29F4D7A}"
 EndProject
@@ -37,7 +37,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Atlassian.Bitbucket", "src\
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Atlassian.Bitbucket.Tests", "src\shared\Atlassian.Bitbucket.Tests\Atlassian.Bitbucket.Tests.csproj", "{025E5329-A0B1-4BA9-9203-B70B44A5F9E0}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Shared.UI.Windows", "src\windows\Shared.UI.Windows\Shared.UI.Windows.csproj", "{2B3CD8FF-84A6-4B53-A28B-D7A75B0AB4D7}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Core.UI.Windows", "src\windows\Core.UI.Windows\Core.UI.Windows.csproj", "{2B3CD8FF-84A6-4B53-A28B-D7A75B0AB4D7}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Packaging.Linux", "src\linux\Packaging.Linux\Packaging.Linux.csproj", "{AD2A935F-3720-4802-8119-6A9B35B254DF}"
 EndProject
@@ -47,9 +47,9 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.UI", "src\shared\Git
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Atlassian.Bitbucket.UI", "src\shared\Atlassian.Bitbucket.UI\Atlassian.Bitbucket.UI.csproj", "{EB1AA840-6FFF-4464-A9B2-0AEA36F615EA}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Git.CredentialManager.UI", "src\shared\Microsoft.Git.CredentialManager.UI\Microsoft.Git.CredentialManager.UI.csproj", "{001846B0-462B-4A27-90CD-2435D4C0F680}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Core.UI", "src\shared\Core.UI\Core.UI.csproj", "{001846B0-462B-4A27-90CD-2435D4C0F680}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Git.CredentialManager.UI.Avalonia", "src\shared\Microsoft.Git.CredentialManager.UI.Avalonia\Microsoft.Git.CredentialManager.UI.Avalonia.csproj", "{DE620324-250C-4262-BA13-198FA6FDB82A}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Core.UI.Avalonia", "src\shared\Core.UI.Avalonia\Core.UI.Avalonia.csproj", "{DE620324-250C-4262-BA13-198FA6FDB82A}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.UI.Avalonia", "src\shared\GitHub.UI.Avalonia\GitHub.UI.Avalonia.csproj", "{459501A8-31E6-41CB-BE54-D31FFF4B2007}"
 EndProject

CONTRIBUTING.md

@@ -35,8 +35,7 @@ Proxy support|✓|✓|✓
 
 **Notes:**
 
-(\*) Debian package offered but not yet available on an official Microsoft feed.
-Fedora packages planned but not yet available.
+(\*) Fedora packages planned but not yet available.
 
 ## Download and Install
 
@@ -89,33 +88,7 @@ sudo /usr/local/share/gcm-core/uninstall.sh
 <a name="linux-install-instructions"></a>
 ### Linux
 
-#### Debian package (.deb)
-
-`apt-get` support is available for Ubuntu Bionic Beaver (18.04) and Hirsute 
-Hippo (21.04). Take the following steps to set up and install based on the
-version you are running:
-
-##### Ubuntu 18.04 (Bionic)
-
-```shell
-curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
-sudo apt-add-repository https://packages.microsoft.com/ubuntu/18.04/prod
-sudo apt-get update
-sudo apt-get install gcmcore
-git-credential-manager-core configure
-```
-
-##### Ubuntu 21.04 (Hirsute)
-
-```shell
-curl -sSL https://packages.microsoft.com/config/ubuntu/21.04/prod.list | sudo tee /etc/apt/sources.list.d/microsoft-prod.list
-curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc
-sudo apt-get update
-sudo apt-get install gcmcore
-git-credential-manager-core configure
-```
-
-##### Other Ubuntu/Debian distributions
+#### Ubuntu/Debian distributions
 
 Download the latest [.deb package](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest), and run the following:
 
@@ -139,7 +112,13 @@ git-credential-manager-core configure
 
 ### Windows
 
-You can download the [latest installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) for Windows to install GCM Core standalone.
+GCM Core is included with [Git for Windows](https://gitforwindows.org/), and the latest version is included in each new Git for Windows release. This is the preferred way to install GCM Core on Windows. During installation you will be asked to select a credential helper, with GCM Core being set as the default.
+
+![image](https://user-images.githubusercontent.com/5658207/140082529-1ac133c1-0922-4a24-af03-067e27b3988b.png)
+
+#### Standalone installation
+
+You can also download the [latest installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) for Windows to install GCM Core standalone.
 
 **:warning: Important :warning:**
 
@@ -173,6 +152,22 @@ 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 [`12294990`](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.

Git-Credential-Manager.sln

@@ -31,14 +31,14 @@
   |   |    |              |                 |                 |
 +-v---v----v--------------v------------+  +-v-----------------v----------------+
 |                                      |  |                                    |
-|    Microsoft.Git.CredentialManager   <--+ Microsoft.Git.CredentialManager.UI |
+|    Core   <--+ Core.UI |
 |                                      |  |                                    |
 +--------------------------------------+  +------------------------------------+
 ```
 
 Git Credential Manager Core (GCM Core) is built to be Git host and platform/OS
 agonstic. Most of the shared logic (command execution, the abstract platform
-subsystems, etc) can be found in the `Microsoft.Git.CredentialManager` class
+subsystems, etc) can be found in the `Core` class
 library (C#). The library targets .NET Standard as well as .NET Framework.
 
 > **Note**
@@ -59,10 +59,10 @@ The entry-point for GCM Core can be found in the `Git-Credential-Manager`
 project, a console application that targets both .NET and .NET Framework.
 This project emits the `git-credential-manager-core(.exe)` executable, and
 contains very little code - registration of all supported host providers and
-running the `Application` object found in `Microsoft.Git.CredentialManager`.
+running the `Application` object found in `Core`.
 
 Providers have their own projects/assemblies that take dependencies on the
-`Microsoft.Git.CredentialManager` core assembly, and are dependents of the main
+`Core` core assembly, and are dependents of the main
 entry point application `Git-Credential-Manager`. Code in these binaries is
 expected to run on all supported platforms and typically (see MSAL.NET note
 above) does not include any graphical user interface; they use terminal prompts
@@ -88,7 +88,7 @@ issue for up-to-date progress on this effort.
 
 For authentication using Microsoft Accounts or Azure Active Directory, things
 are a little different. The `MicrosoftAuthentication` component is present in
-the core `Microsoft.Git.CredentialManager` assembly, rather than bundled with a
+the core `Core` assembly, rather than bundled with a
 specific host provider. This was done to allow any service that may wish to in
 the future integrate with Microsoft Accounts or Azure Active Directory can make
 use of this reusable authentication component.
@@ -148,7 +148,7 @@ Git Credential Manager Core maintains a set of known commands including
 GCM Core also maintains a set of known, registered host providers that implement
 the `IHostProvider` interface. Providers register themselves by adding an
 instance of the provider to the `Application` object via the `RegisterProvider`
-method [in `Microsoft.Git.CredentialManager.Program`](../src/shared/Git-Credential-Manager/Program.cs).
+method [in `Core.Program`](../src/shared/Git-Credential-Manager/Program.cs).
 The `GenericHostProvider` is registered last so that it can handle all other
 HTTP-based remotes as a catch-all, and provide basic username/password auth and
 detect the presence of Windows Integrated Authentication (Kerberos, NTLM,

README.md

@@ -31,6 +31,11 @@ hostname can be made. Only one HTTP `HEAD` call is made per credential request
 received by Git. To avoid this network call, please [explicitly configure](#explicit-configuration)
 the host provider for your self-hosted instance.
 
+After a successful detection of the host provider, GCM will automatically set
+the [`credential.provider` configuration entry](configuration.md#credentialprovider)
+for that remote to avoid needing to perform this expensive network call in
+future requests.
+
 ### Timeout
 
 You can control how long GCM will wait for a response to the remote network call
@@ -41,7 +46,7 @@ Git configuration setting to the maximum number of milliseconds to wait.
 The default value is 2000 milliseconds (2 seconds). You can prevent the network
 call altogether by setting a zero or negative value, for example -1.
 
-## Explicit configuration
+## Manual configuration
 
 If the auto-detection mechanism fails to select the correct host provider, or
 if the remote probing network call is causing performance issues, you can

docs/architecture.md

@@ -209,7 +209,8 @@ _(unset)_|Automatically detect modes
 `oauth`|Expands to: `browser, device`
 `browser`|OAuth authentication via a web browser _(requires a GUI)_
 `device`|OAuth authentication with a device code
-`basic`|Basic/PAT-based authentication
+`basic`|Basic authentication using username and password
+`pat`|Personal Access Token (pat)-based authentication
 
 #### Example
 
@@ -394,7 +395,7 @@ Value|Git Behavior
 On Windows using GitHub, for a user whose login is `alice`, and with `credential.useHttpPath` set to `false` (or not set), the following remote URLs will use the same credentials:
 
 ```text
-Credential: "git:https://github.com" (user = alice) 
+Credential: "git:https://github.com" (user = alice)
 
    https://github.com/foo/bar
    https://github.com/contoso/widgets

docs/autodetect.md

@@ -3,6 +3,7 @@
 There are several options for storing credentials that GCM Core supports:
 
 - Windows Credential Manager
+- DPAPI protected files
 - macOS Keychain
 - [freedesktop.org Secret Service API](https://specifications.freedesktop.org/secret-service/)
 - GPG/[`pass`](https://www.passwordstore.org/) compatible files