Appearance

Powered by Platform One

Commit Signing with GPG ​

Overview ​

Use this document to understand commit signing and how to set your operating system up to sign commits with a GPG. Developers who don't have a CAC can sign their commits using a GPG key. To learn how to sign commits using a CAC, follow the Commit Signing with CAC How-To Guide.

IMPORTANT

If your projects are in IL4 and IL5, you must sign commits with your CAC instead.

Store your GPG private key in a secure place. It should be treated like a password.

Party Bus does not support using IDE's for code signing. You are free to do so, but if you cannot sign commits in your IDE, please do not open a ticket with the Party Bus help desk. You will need to fix your issue or use the command line to sign commits that you create in your IDE.

Step-by-Step Guide ​

Mac Setup ​

Windows Setup ​

Common Errors ​

General Troubleshooting ​

While debugging, commits may be traced using GIT_TRACE=1.

INFO

EXAMPLE:GIT_TRACE=1 git commit -S -m "test commit"

Commit "Unverified" in GitLab ​

Make sure the user.email Git variable has been set. To set it, execute: git config --global user.email < GitLab email >.

Error: GPG failed to sign the data fatal: failed to write commit object ​

Refer to this Stack Overflow entry for additional error details and suggested solutions.

To resolve, complete the following:

  1. Execute echo "test" | gpg --clear-sign. If the result is this: echotest1

    • Execute export GPG_TTY=$(tty).

    • Execute echo "test" | gpg --clear-sign again. The result should be something like this: echotest2

    • If the result is this:

      bash
      gpg: signing failed: Timeout
gpg: [stdin]: clear-sign failed: Timeout

      Restart the gpg-agent and then retry the command again.

      bash
      gpgconf --kill gpg-agent

Could Not Find Identity Matching Specified user-id ​

If you receive a message on commit similar to the below error, it could be caused by conflicting GPG format settings in the Git config.

could not find identity matching specified user-id: XXXXXXXXXX
error: gpg failed to sign the data
fatal: failed to write commit object
  1. Check if the gpg.format is set by running this command: git config --get gpg.format.
  2. Try unsetting it if it returns a value by running this command: git config --unset gpg.format. Run the above command again to verify it is no longer set.
  3. If it’s still set, manually remove it from ~/.gitconfig by deleting the gpg.format and/or the format line under [gpg].
  4. Run git config --get gpg.format again to ensure it was actually removed.
  5. Retry your commit.

Related Content/References ​

Install Required Software ​

Review Supporting Documentation ​

Powered By Platform One