Skip to content

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

@DrJosh9000

Description

@DrJosh9000

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(...) user@example.com'

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    authenticationContent relating to authenticationcontentThis issue or pull request belongs to the Docs Content teamwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions