Support git commit -s (--signoff)

[lentzi90]

It is quite common that projects require contributors to sign-off their work by using the -s or --signoff feature in git.
Now that the git support in zed is progressing well, I noticed that this is something I miss in the UI.

If I recall correctly, Atom used to have a little checkbox under the commit message area for this. I think that would be a great way to implement it.

[jberkus]

Either that, or a configuration option. A config option could support GPG signing as well.

[jberkus]

there's no way to pass --signoff to zed, though.

[lentzi90]

Exactly, this is what I am asking for. My comment above was just to explain that GPG signing can already be done by adding the following to .gitconfig:

[commit]
	gpgsign = true

There is no such option for --signoff, so we need a feature in zed for that 🙂

[PatzEdi]

Exactly, this is what I am asking for. My comment above was just to explain that GPG signing can already be done by adding the following to .gitconfig:

[commit]
	gpgsign = true

There is no such option for --signoff, so we need a feature in zed for that 🙂

Not sure with GPG signing through GPG keys, that might work as you said. However, when signing with ssh Zed does not work. I might need to open an issue. Here is a snippet from my git config:

[commit]
    gpgsign = true
[gpg]
    format = ssh

When committing, Zed returns an error in the log:

Failed to commit:
error: Enter passphrase for "(path/to/key)": Load key "(path/to/key)": incorrect passphrase supplied to decrypt private key?

fatal: failed to write commit object

Where I have replaced my path to my ssh key with "(path/to/key)". Not sure if there are issues regarding GPG signing with ssh format yet, probably should have checked before posting this, but ey, will do so anyway ;)

[4ad]

It does work, but it requires a ssh agent with the key loaded in the agent.

I don't want to use an ssh agent all the time, so I have this in .gitconfig:

[gpg]
        format = ssh
[gpg "ssh"]
        defaultKeyCommand = /Users/aram/bin/git-config-helper-gpg.ssh.defaultKeyCommand

Git will call that helper before doing the signing, that helper is:

#/bin/bash

ssh-add -q -t 5 --apple-load-keychain ~/.ssh/id_ed25519
KEY=$(ssh-add -L | head -n 1)
echo key::$KEY

(Adjust as needed.)

It loads the key in the ssh agent with a timeout of 5 seconds. With this, git ssh signing works for me on a mac, both in Zed, and outside it.

Git ssh signing just uses ssh-keygen -Y sign and that pretty much requires you to use an ssh agent, it's unavoidable.

[PatzEdi]

It does work, but it requires a ssh agent with the key loaded in the agent.

I don't want to use an ssh agent all the time, so I have this in .gitconfig:

[gpg]
        format = ssh
[gpg "ssh"]
        defaultKeyCommand = /Users/aram/bin/git-config-helper-gpg.ssh.defaultKeyCommand

Git will call that helper before doing the signing, that helper is:

#/bin/bash

ssh-add -q -t 5 --apple-load-keychain ~/.ssh/id_ed25519
KEY=$(ssh-add -L | head -n 1)
echo key::$KEY

(Adjust as needed.)

It loads the key in the ssh agent with a timeout of 5 seconds. With this, git ssh signing works for me on a mac, both in Zed, and outside it.

Git ssh signing just uses ssh-keygen -Y sign and that pretty much requires you to use an ssh agent, it's unavoidable.

Wonderful solution, thanks for this! I tried it out and it does indeed work.

Just a note for anyone struggling to make this work: make sure user.signingkey is unset, as that overrides the call to the shell script that adds the stored ssh key to the agent. If you don't remove that from the .gitconfig, you will still be asked a passphrase, and Zed won't be able to commit. That is based on my experience, but just a note in case it still doesn't work.

Additionally, I would make sure that the shell script you pass to the [gpg "ssh"] section of the .gitconfig to define defaultKeyCommand is executable via chmod +x. It may be necessary and/or handle edge cases better.

Thanks again!

[4ad]

There also needs a way to control git commit signing (git commit -S). Yes, you can enable signing for all commits in the git configuration, but you might not want that, you might want to only sign specific commits.

[ericcornelissen]

For visibility: I started #29874 to add the --signoff option.