sign

Documentation

Index

• func GetCommitSignKey(armoredKeyRing string, keyPassphrase string) (*openpgp.Entity, error)
• func SignCommit(commit *object.Commit, signer *openpgp.Entity) (*object.Commit, error)
• func ValidateGPGKey(armoredKeyRing, passphrase string) error
• type GPGSpec

Functions

func GetCommitSignKey

func GetCommitSignKey(armoredKeyRing string, keyPassphrase string) (*openpgp.Entity, error)

GetCommitSignKey returns the gpg key used to sign the commit message

func SignCommit

func SignCommit(commit *object.Commit, signer *openpgp.Entity) (*object.Commit, error)

SignCommit signs a git commit object using the provided GPG key

func ValidateGPGKey

func ValidateGPGKey(armoredKeyRing, passphrase string) error

ValidateGPGKey validates that the GPG key can be used for signing

Types

type GPGSpec

type GPGSpec struct {
	/*
		signingKey defines the gpg key used to sign the commit message

		default:
			none
	*/
	SigningKey string `yaml:",omitempty"`
	/*
		passphrase defines the gpg passphrase used to sign the commit message
	*/
	Passphrase string `yaml:",omitempty"`
}

GPGSpec defines the specification for manipulating gpg keys in the context of git commits.