diff options
author | 2025-05-05 04:31:46 +0000 | |
---|---|---|
committer | 2025-05-05 04:37:26 +0000 | |
commit | 0c30e143bf41f5bbbe295abdd0cb5bad9f5da9f6 (patch) | |
tree | 67b4227fdb20cbcd0f46448247b70e2995972b7d | |
parent | b822d411aa101adb298429e6dcf04110122aba15 (diff) | |
download | YubiKey-Guide-0c30e143bf41f5bbbe295abdd0cb5bad9f5da9f6.tar.gz YubiKey-Guide-0c30e143bf41f5bbbe295abdd0cb5bad9f5da9f6.tar.zst YubiKey-Guide-0c30e143bf41f5bbbe295abdd0cb5bad9f5da9f6.zip |
Update instructions for commit signing
- Using a SSH key for signing
- Snippet demonstrating configuring the Git user identity
- Enabling commit and tag signing by default
-rw-r--r-- | README.md | 23 |
1 files changed, 20 insertions, 3 deletions
@@ -1663,15 +1663,32 @@ The path must be set according to `gpgconf --list-dirs agent-ssh-socket` on *rem YubiKey can be used to sign commits and tags, and authenticate SSH to GitHub when configured in [Settings](https://github.com/settings/keys). -Configure a signing key: +Configure the signing key: ```console git config --global user.signingkey $KEYID ``` -Configure the `user.email` option to match the email address associated with the PGP identity. +Alternatively, if you are using the aforementioned `IdentityFile` (SSH key) for signing: -To sign commits or tags, use the `-S` option. +```console +git config --global gpg.format ssh +git config --global user.signingkey ~/.ssh/id_rsa_yubikey.pub +``` + +Configure the `user.name` and `user.email` option to match the email address associated with the PGP identity: + +```console +git config --global user.name 'YubiKey User' +git config --global user.email yubikey@example +``` + +To sign commits or tags, use the `-S` option, or consider enabling commit and tag signing by default: + +```console +git config --global commit.gpgsign true +git config --global tag.gpgSign true +``` **Windows** |