Skip to content

Commit

Permalink
docs(DEVELOPER.md): fix the guide of authentication (#13489)
Browse files Browse the repository at this point in the history
  • Loading branch information
ADD-SP authored and ProBrian committed Aug 13, 2024
1 parent 7636e1b commit 0cdc151
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,23 @@ An alternative is to edit the `~/.cargo/config` file and add the following lines
git-fetch-with-cli = true
```

You also have to make sure the `git` CLI is using the proper protocol to fetch the dependencies
if you are authenticated with
[Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

```shell
# If you are using the HTTPS protocol to clone the repository
# YOU ONLY NEED TO DO THIS ONLY ONCE FOR THIS DIRECTORY
git config --local url."https://${GITHUB_TOKEN}@github.com/".insteadOf '[email protected]:'
git config --local url."https://${GITHUB_TOKEN}@github.com".insteadOf 'https://github.com'


# If you are using the SSH protocol to clone the repository
# YOU ONLY NEED TO DO THIS ONLY ONCE FOR THIS DIRECTORY
git config --local url.'[email protected]:'.insteadOf 'https://github.com'
git config --local url.'ssh://[email protected]/'.insteadOf 'https://github.com/'
```

Finally, we start the build process:

```
Expand Down

0 comments on commit 0cdc151

Please sign in to comment.