Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(DEVELOPER.md): fix the guide of authentication #13489

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading