Skip to content

Commit ff08037

Browse files
authored
Merge pull request #541 from ldennington/remove-core-from-docs
Remove 'core' from docs
2 parents 703959b + 660f9f7 commit ff08037

35 files changed

+172
-172
lines changed

.github/ISSUE_TEMPLATE/auth-problem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels: 'auth-issue'
66
assignees: ''
77
---
88

9-
**Which version of GCM Core are you using?**
9+
**Which version of GCM are you using?**
1010

1111
From a terminal, run `git credential-manager-core --version` and paste the output.
1212

.github/ISSUE_TEMPLATE/experimental.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels: 'experimental'
66
assignees: ''
77
---
88

9-
**Which version of GCM Core are you using?**
9+
**Which version of GCM are you using?**
1010

1111
From a terminal, run `git-credential-manager-core --version` and paste the output.
1212

.github/ISSUE_TEMPLATE/feature-req.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: A suggestion for a new feature in Git Credential Manager Core.
3+
about: A suggestion for a new feature in Git Credential Manager.
44
title: ''
55
labels: 'enhancement'
66
assignees: ''

.github/workflows/continuous-integration.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: GCM-Core
1+
name: GCM
22

33
on:
44
workflow_dispatch:

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Contributing
22

3-
[issue]: https://github.com/microsoft/Git-Credential-Manager-Core/issues
4-
[fork]: https://github.com/microsoft/Git-Credential-Manager-Core/fork
5-
[pr]: https://github.com/microsoft/Git-Credential-Manager-Core/compare
3+
[issue]: https://github.com/GitCredentialManager/git-credential-manager/issues
4+
[fork]: https://github.com/GitCredentialManager/git-credential-manager/fork
5+
[pr]: https://github.com/GitCredentialManager/git-credential-manager/compare
66
[code-of-conduct]: CODE_OF_CONDUCT.md
77

88
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Git Credential Manager Core
1+
Git Credential Manager
22
Copyright © GitHub, Inc. and contributors
33

44
MIT License

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
NOTICES AND INFORMATION
22
Do Not Translate or Localize
33

4-
This repository for Git Credential Manager Core includes material from the
4+
This repository for Git Credential Manager includes material from the
55
projects listed below.
66

77
--------------------------------------------------------------------------------

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Git Credential Manager Core
1+
# Git Credential Manager
22

3-
[![Build Status](https://github.com/microsoft/Git-Credential-Manager-Core/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/microsoft/Git-Credential-Manager-Core/actions/workflows/continuous-integration.yml)
3+
[![Build Status](https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml)
44

55
---
66

7-
[Git Credential Manager Core](https://github.com/microsoft/Git-Credential-Manager-Core) (GCM Core) is a secure Git credential helper built on [.NET](https://dotnet.microsoft.com) that runs on Windows, macOS, and Linux.
7+
[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) is a secure Git credential helper built on [.NET](https://dotnet.microsoft.com) that runs on Windows, macOS, and Linux.
88

9-
Compared to Git's [built-in credential helpers]((https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)) (Windows: wincred, macOS: osxkeychain, Linux: gnome-keyring/libsecret) which provides single-factor authentication support working on any HTTP-enabled Git repository, GCM Core provides multi-factor authentication support for [Azure DevOps](https://dev.azure.com/), Azure DevOps Server (formerly Team Foundation Server), GitHub, and Bitbucket.
9+
Compared to Git's [built-in credential helpers]((https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)) (Windows: wincred, macOS: osxkeychain, Linux: gnome-keyring/libsecret) which provides single-factor authentication support working on any HTTP-enabled Git repository, GCM provides multi-factor authentication support for [Azure DevOps](https://dev.azure.com/), Azure DevOps Server (formerly Team Foundation Server), GitHub, and Bitbucket.
1010

11-
Git Credential Manager Core (GCM Core) replaces the .NET Framework-based [Git Credential Manager for Windows](https://github.com/microsoft/Git-Credential-Manager-for-Windows) (GCM), and the Java-based [Git Credential Manager for Mac and Linux](https://github.com/microsoft/Git-Credential-Manager-for-Mac-and-Linux) (Java GCM), providing a consistent authentication experience across all platforms.
11+
Git Credential Manager (GCM) replaces the .NET Framework-based [Git Credential Manager for Windows](https://github.com/microsoft/Git-Credential-Manager-for-Windows) (GCM), and the Java-based [Git Credential Manager for Mac and Linux](https://github.com/microsoft/Git-Credential-Manager-for-Mac-and-Linux) (Java GCM), providing a consistent authentication experience across all platforms.
1212

1313
## Current status
1414

15-
Git Credential Manager Core is currently available for Windows, macOS, and Linux. GCM only works with HTTP(S) remotes; you can still use Git with SSH:
15+
Git Credential Manager is currently available for Windows, macOS, and Linux. GCM only works with HTTP(S) remotes; you can still use Git with SSH:
1616

1717
- [Azure DevOps SSH](https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops)
1818
- [GitHub SSH](https://help.github.com/en/articles/connecting-to-github-with-ssh)
@@ -58,7 +58,7 @@ brew upgrade git-credential-manager-core
5858

5959
#### Git Credential Manager for Mac and Linux (Java-based GCM)
6060

61-
If you have an existing installation of the 'Java GCM' on macOS and you have installed this using Homebrew, this installation will be unlinked (`brew unlink git-credential-manager`) when GCM Core is installed.
61+
If you have an existing installation of the 'Java GCM' on macOS and you have installed this using Homebrew, this installation will be unlinked (`brew unlink git-credential-manager`) when GCM is installed.
6262

6363
#### Uninstall
6464

@@ -72,7 +72,7 @@ brew uninstall --cask git-credential-manager-core
7272

7373
### macOS Package
7474

75-
We also provide a [.pkg installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) with each release. To install, double-click the installation package and follow the instructions presented.
75+
We also provide a [.pkg installer](https://github.com/GitCredentialManager/git-credential-manager/releases/latest) with each release. To install, double-click the installation package and follow the instructions presented.
7676

7777
#### Uninstall
7878

@@ -90,7 +90,7 @@ sudo /usr/local/share/gcm-core/uninstall.sh
9090

9191
#### Ubuntu/Debian distributions
9292

93-
Download the latest [.deb package](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest), and run the following:
93+
Download the latest [.deb package](https://github.com/GitCredentialManager/git-credential-manager/releases/latest), and run the following:
9494

9595
```shell
9696
sudo dpkg -i <path-to-package>
@@ -103,30 +103,30 @@ Debian package using the above instructions instead.
103103

104104
#### Other distributions
105105

106-
Download the latest [tarball](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest), and run the following:
106+
Download the latest [tarball](https://github.com/GitCredentialManager/git-credential-manager/releases/latest), and run the following:
107107

108108
```shell
109109
tar -xvf <path-to-tarball> -C /usr/local/bin
110110
git-credential-manager-core configure
111111
```
112112

113-
**Note:** all Linux distributions [require additional configuration](https://aka.ms/gcmcore-credstores) to use GCM Core.
113+
**Note:** all Linux distributions [require additional configuration](https://aka.ms/gcm/credstores) to use GCM.
114114

115115
---
116116

117117
### Windows
118118

119-
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.
119+
GCM 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 on Windows. During installation you will be asked to select a credential helper, with GCM being set as the default.
120120

121121
![image](https://user-images.githubusercontent.com/5658207/140082529-1ac133c1-0922-4a24-af03-067e27b3988b.png)
122122

123123
#### Standalone installation
124124

125-
You can also download the [latest installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) for Windows to install GCM Core standalone.
125+
You can also download the [latest installer](https://github.com/GitCredentialManager/git-credential-manager/releases/latest) for Windows to install GCM standalone.
126126

127127
**:warning: Important :warning:**
128128

129-
Installing GCM Core as a standalone package on Windows will forcibly override the version of GCM Core that is bundled with Git for Windows, **even if the version bundled with Git for Windows is a later version**.
129+
Installing GCM as a standalone package on Windows will forcibly override the version of GCM that is bundled with Git for Windows, **even if the version bundled with Git for Windows is a later version**.
130130

131131
There are two flavors of standalone installation on Windows:
132132

@@ -142,23 +142,23 @@ To install, double-click the desired installation package and follow the instruc
142142

143143
#### Uninstall (Windows 10)
144144

145-
To uninstall, open the Settings app and navigate to the Apps section. Select "Git Credential Manager Core" and click "Uninstall".
145+
To uninstall, open the Settings app and navigate to the Apps section. Select "Git Credential Manager" and click "Uninstall".
146146

147147
#### Uninstall (Windows 7-8.1)
148148

149-
To uninstall, open Control Panel and navigate to the Programs and Features screen. Select "Git Credential Manager Core" and click "Remove".
149+
To uninstall, open Control Panel and navigate to the Programs and Features screen. Select "Git Credential Manager" and click "Remove".
150150

151151
#### Windows Subsystem for Linux (WSL)
152152

153-
Git Credential Manager Core can be used with the [Windows Subsystem for Linux
153+
Git Credential Manager can be used with the [Windows Subsystem for Linux
154154
(WSL)](https://aka.ms/wsl) to enable secure authentication of your remote Git
155155
repositories from inside of WSL.
156156

157-
[Please see the GCM Core on WSL docs](docs/wsl.md) for more information.
157+
[Please see the GCM on WSL docs](docs/wsl.md) for more information.
158158

159159
## Supported Git versions
160160

161-
Git Credential Manager Core tries to be compatible with the broadest set of Git
161+
Git Credential Manager tries to be compatible with the broadest set of Git
162162
versions (within reason). However there are some know problematic releases of
163163
Git that are not compatible.
164164

@@ -174,17 +174,17 @@ Git that are not compatible.
174174

175175
## How to use
176176

177-
Once it's installed and configured, Git Credential Manager Core is called implicitly by Git.
178-
You don't have to do anything special, and GCM Core isn't intended to be called directly by the user.
177+
Once it's installed and configured, Git Credential Manager is called implicitly by Git.
178+
You don't have to do anything special, and GCM isn't intended to be called directly by the user.
179179
For example, when pushing (`git push`) to [Azure DevOps](https://dev.azure.com), [Bitbucket](https://bitbucket.org), or [GitHub](https://github.com), a window will automatically open and walk you through the sign-in process.
180180
(This process will look slightly different for each Git host, and even in some cases, whether you've connected to an on-premises or cloud-hosted Git host.)
181-
Later Git commands in the same repository will re-use existing credentials or tokens that GCM Core has stored for as long as they're valid.
181+
Later Git commands in the same repository will re-use existing credentials or tokens that GCM has stored for as long as they're valid.
182182

183183
Read full command line usage [here](docs/usage.md).
184184

185185
### Configuring a proxy
186186

187-
See detailed information [here](https://aka.ms/gcmcore-httpproxy).
187+
See detailed information [here](https://aka.ms/gcm/httpproxy).
188188

189189
## Additional Resources
190190

docs/architecture.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
+--------------------------------------+ +------------------------------------+
3737
```
3838

39-
Git Credential Manager Core (GCM Core) is built to be Git host and platform/OS
39+
Git Credential Manager (GCM) is built to be Git host and platform/OS
4040
agonstic. Most of the shared logic (command execution, the abstract platform
4141
subsystems, etc) can be found in the `Core` class
4242
library (C#). The library targets .NET Standard as well as .NET Framework.
@@ -52,10 +52,10 @@ library (C#). The library targets .NET Standard as well as .NET Framework.
5252
> our own browser pop-up handling code on .NET meaning both Windows and
5353
> Mac. We haven't yet gotten around to exploring this.
5454
>
55-
> See [this](https://github.com/microsoft/Git-Credential-Manager-Core/issues/113)
55+
> See [this](https://github.com/GitCredentialManager/git-credential-manager/issues/113)
5656
> issue for more information.
5757
58-
The entry-point for GCM Core can be found in the `Git-Credential-Manager`
58+
The entry-point for GCM can be found in the `Git-Credential-Manager`
5959
project, a console application that targets both .NET and .NET Framework.
6060
This project emits the `git-credential-manager-core(.exe)` executable, and
6161
contains very little code - registration of all supported host providers and
@@ -81,21 +81,21 @@ helpers on Windows.
8181
### Cross-platform UI
8282

8383
We hope to be able to migrate the WPF/Windows only helpers to [Avalonia](https://avaloniaui.net/)
84-
in order to gain cross-platform graphical user interface support. See [this](https://github.com/microsoft/Git-Credential-Manager-Core/issues/136)
84+
in order to gain cross-platform graphical user interface support. See [this](https://github.com/GitCredentialManager/git-credential-manager/issues/136)
8585
issue for up-to-date progress on this effort.
8686

8787
### Microsoft authentication
8888

8989
For authentication using Microsoft Accounts or Azure Active Directory, things
9090
are a little different. The `MicrosoftAuthentication` component is present in
91-
the core `Core` assembly, rather than bundled with a
91+
the `Core` core assembly, rather than bundled with a
9292
specific host provider. This was done to allow any service that may wish to in
9393
the future integrate with Microsoft Accounts or Azure Active Directory can make
9494
use of this reusable authentication component.
9595

9696
## Asynchronous programming
9797

98-
GCM Core makes use of the `async`/`await` model of .NET and C# in almost all
98+
GCM makes use of the `async`/`await` model of .NET and C# in almost all
9999
parts of the codebase where appropriate as usually requests end up going to the
100100
network at some point.
101101

@@ -142,10 +142,10 @@ network at some point.
142142
+---------------+
143143
```
144144

145-
Git Credential Manager Core maintains a set of known commands including
145+
Git Credential Manager maintains a set of known commands including
146146
`Get|Store|EraseCommand`, as well as commands for install and help/usage.
147147

148-
GCM Core also maintains a set of known, registered host providers that implement
148+
GCM also maintains a set of known, registered host providers that implement
149149
the `IHostProvider` interface. Providers register themselves by adding an
150150
instance of the provider to the `Application` object via the `RegisterProvider`
151151
method [in `Core.Program`](../src/shared/Git-Credential-Manager/Program.cs).
@@ -154,7 +154,7 @@ HTTP-based remotes as a catch-all, and provide basic username/password auth and
154154
detect the presence of Windows Integrated Authentication (Kerberos, NTLM,
155155
Negotiate) support (1).
156156

157-
For each invocation of GCM Core, the first argument on the command-line is
157+
For each invocation of GCM, the first argument on the command-line is
158158
matched against the known commands and if there is a successful match, the input
159159
from Git (over standard input) is deserialized and the command is executed (2).
160160

@@ -174,7 +174,7 @@ context to complete the requested operation (5).
174174
Once a credential has been created, retrieved, stored or erased, the host
175175
provider returns the credential (for `get` operations only) to the calling
176176
command (6). The credential is then serialized and returned to Git over standard
177-
output (7) and GCM Core terminates with a successful exit code.
177+
output (7) and GCM terminates with a successful exit code.
178178

179179
## Host provider
180180

@@ -247,7 +247,7 @@ systems and platforms.
247247
Component|Description
248248
-|-
249249
CredentialStore|A secure operating system controlled location for storing and retrieving `ICredential` objects.
250-
Settings|Abstraction over all GCM Core settings.
250+
Settings|Abstraction over all GCM settings.
251251
Streams|Abstraction over standard input, output and error streams connected to the parent process (typically Git).
252252
Terminal|Provides interactions with an attached terminal, if it exists.
253253
SessionManager|Provides information about the current user session.
@@ -260,7 +260,7 @@ SystemPrompts|Provides services for showing system/OS native credential prompts.
260260

261261
## Error handling and tracing
262262

263-
GCM Core operates a 'fail fast' approach to unrecoverable errors. This usually
263+
GCM operates a 'fail fast' approach to unrecoverable errors. This usually
264264
means throwing an `Exception` which will propagate up to the entry-point and be
265265
caught, a non-zero exit code returned, and the error message printed with the
266266
"fatal:" prefix. For errors originating from interop/native code, you should
@@ -276,4 +276,4 @@ operation/authentication.
276276

277277
The `ITrace` component can be found on the `ICommandContext` object or passed in
278278
directly to some constructors. Verbose and diagnostic information is be written
279-
to the trace object in most places of GCM Core.
279+
to the trace object in most places of GCM.

0 commit comments

Comments
 (0)