Skip to content

Commit

Permalink
Update rename doc to mention symlink removal (git-ecosystem#1363)
Browse files Browse the repository at this point in the history
In GCM 2.3 we dropped the symlinks.
Let's update our docs on the issue to reflect this.

Rendered:
https://github.com/git-ecosystem/git-credential-manager/blob/rename-docs-update/docs/rename.md
  • Loading branch information
mjcheetham authored Aug 2, 2023
2 parents 1dc6fb0 + 2d1a2bc commit 4c3a5bc
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ At the time, the actual exectuable name was not updated and continued to be
`git-credential-manager-core`. As of [2.0.877][rename-ver], the executable has
been renamed to `git-credential-manager`, matching the new project name.

---

:warning: **Update:** :warning:

As of [2.3.0][no-symlink-ver] the `git-credential-manager-core` symlinks have been
removed.

If you have not updated your configuration you will see error messages similar to:

```console
git: 'credential-manager-core' is not a git command. See 'git --help'.
```

To fix your configuration, please follow the [instructions][instructions] below.

---

## Rename transition

If you continue to use the `git-credential-manager-core` executable name you may
Expand All @@ -35,7 +52,7 @@ name as soon as possible to prevent any issues in the future.
### Git for Windows

If you are using GCM bundled with Git for Windows (recommended), you should make
sure you have updated to at least version WINGIT_VERSION.
sure you have updated to the latest version.

[Download the latest Git for Windows ⬇️][git-windows]

Expand Down Expand Up @@ -164,3 +181,5 @@ or `manager` respectively.
[gcm-latest]: https://aka.ms/gcm/latest
[warnings]: #rename-transition
[win-standalone-instr]: ../README.md#standalone-installation
[instructions]: #how-to-update
[no-symlink-ver]: https://github.com/git-ecosystem/git-credential-manager/releases/tag/v2.3.0

0 comments on commit 4c3a5bc

Please sign in to comment.