#33585: lacking hint to SSH setup (Working with Git and GitHub)
-------------------------------------+-------------------------------------
Reporter: Samuel | Owner: Samuel Hartmann
Hartmann |
Type: Bug | Status: assigned
Component: | Version: dev
Documentation | Keywords: documentation, git,
Severity: Normal | github contributing, contribution
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
Starting to work on #33544 I found the following:
The explanation
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/working-with-git/#setting-up-local-repository "Setting up local
repository"] in "Working with Git and GitHub" quitely assumes that people
have already set up their local Git and GitHub for use of SSH.
They say:
> You should also set up django/django as an “upstream” remote (that is,
tell git that the reference Django repository was the source of your fork
of it):
>
>
> {{{
> git remote add upstream [email protected]:django/django.git
> git fetch upstream
> }}}
I didn't set up SSH before.
Hence I got the following error when running `git fetch upstream`:
{{{
The authenticity of host 'github.com (140.82.121.4)' can't be established.
ED25519 key fingerprint is
SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'github.com' (ED25519) to the list of known
hosts.
[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
}}}
The reason and solution for that error are described in
[https://stackoverflow.com/a/12940681 this stackoverflow reply].
Basically you need to set up an SSH key on your local machine and add it
to your GitHub profile.
This enables you to [https://docs.github.com/en/authentication/connecting-
to-github-with-ssh connect to GitHub].
I suggest two possible solutions:
1. insert a new section after the
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/working-with-git/#installing-git Installing Git] section
2. change the SSH notations (like git@^^github.com:django/django.git) to
HTTPS notations (like https://github.com/django/django.git) instead
If the second approach makes sense, I'd prefer this one because it's
easier to understand and needs less effort from a setup perspective.
Hence simplifies the start for first time contributers.
--
Ticket URL: <https://code.djangoproject.com/ticket/33585>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107017f9dd91338-ab58dc28-4e99-4807-b205-6f12ffb074ac-000000%40eu-central-1.amazonses.com.
