SSH commit signing: Missing "key::" prefix for literal key in setup instructions

[DrJosh9000]

Code of Conduct

• [X] 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/managing-commit-signature-verification/telling-git-about-your-signing-key

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

Step 4 of "Telling Git about your SSH key" configures the signing key incorrectly. When using the literal contents of a key, the config value needs to be prefixed with "key::", e.g.

$ git config --global user.signingkey 'key::ssh-ed25519 AAAAC3(...) [email protected]'

With a key residing in a file, the path to the key can be provided (without a prefix).

See also https://lore.kernel.org/git/20220628162342.ootjobbjtxg7b7ay@fs/t/

Additional information

No response

[welcome[bot]]

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]

@DrJosh9000 Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes: