Adding your SSH key to the ssh-agent instructions are incorrect

[simonw]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

This bit:

docs/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md

Line 128 in 5c6e715

Host *.{% ifversion ghes or ghae %}HOSTNAME{% else %}github.com{% endif %}

What part(s) of the article would you like to see updated?

The instructions say that you should edit ~/.ssh/config and add this to it:

Host *.github.com
  AddKeysToAgent yes
  UseKeychain yes
  IdentityFile ~/.ssh/id_ed25519

I tried that, but when I ran git clone git@github.com:simonw/sqlite-utils I still had to enter my password.

When I changed it to this my command worked correctly as expected, without asking for my password:

Host github.com
  AddKeysToAgent yes
  UseKeychain yes
  IdentityFile ~/.ssh/id_ed25519

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

@simonw Thank you for opening an issue and linking it to your PR! ✨