README.md

About

GitHub Action to easily import a GPG key.

If you are interested, check out my other GitHub Actions!

---

• Features
• Prerequisites
• Usage
  • Workflow
  • Sign commits
• Customizing
  • inputs
  • outputs
• Contributing
• License

Features

• Works on Linux, MacOS and Windows virtual environments
• Allow to seed the internal cache of gpg-agent with provided passphrase
• Purge imported GPG key, cache information and kill agent from runner
• (Git) Enable signing for Git commits, tags and pushes
• (Git) Configure and check committer info against GPG key

Prerequisites

First, generate a GPG key and export the GPG private key as an ASCII armored version to your clipboard:

# macOS
gpg --armor --export-secret-key joe@foo.bar | pbcopy

# Ubuntu (assuming GNU base64)
gpg --armor --export-secret-key joe@foo.bar -w0 | xclip

# Arch
gpg --armor --export-secret-key joe@foo.bar | xclip -selection clipboard -i

# FreeBSD (assuming BSD base64)
gpg --armor --export-secret-key joe@foo.bar | xclip

Paste your clipboard as a secret named GPG_PRIVATE_KEY for example. Create another secret with the PASSPHRASE if applicable.

Usage

Workflow

name: import-gpg

on:
  push:
    branches: master

jobs:
  import-gpg:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Import GPG key
        id: import_gpg
        uses: crazy-max/ghaction-import-gpg@v3
        with:
          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
      -
        name: GPG user IDs
        run: |
          echo "fingerprint: ${{ steps.import_gpg.outputs.fingerprint }}"
          echo "keyid:       ${{ steps.import_gpg.outputs.keyid }}"
          echo "name:        ${{ steps.import_gpg.outputs.name }}"
          echo "email:       ${{ steps.import_gpg.outputs.email }}"

Sign commits

name: import-gpg

on:
  push:
    branches: master

jobs:
  sign-commit:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Import GPG key
        uses: crazy-max/ghaction-import-gpg@v3
        with:
          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          git-user-signingkey: true
          git-commit-gpgsign: true
      -
        name: Sign commit and push changes
        run: |
          echo foo > bar.txt
          git add .
          git commit -S -m "This commit is signed!"
          git push

Customizing

inputs

Following inputs can be used as step.with keys

Name	Type	Description
gpg-private-key	String	GPG private key exported as an ASCII armored version or its base64 encoding (required)
passphrase	String	Passphrase of the GPG private key
git-config-global	Bool	Set Git config global (default false)
git-user-signingkey	Bool	Set GPG signing keyID for this Git repository (default false)
git-commit-gpgsign¹	Bool	Sign all commits automatically. (default false)
git-tag-gpgsign¹	Bool	Sign all tags automatically. (default false)
git-push-gpgsign¹	String	Sign all pushes automatically. (default if-asked)
git-committer-name¹	String	Set commit author's name (defaults to the name associated with the GPG key)
git-committer-email¹	String	Set commit author's email (defaults to the email address associated with the GPG key)
workdir	String	Working directory (below repository root) (default .)

¹ git-user-signingkey needs to be enabled for these inputs to be used.

outputs

Following outputs are available

Name	Type	Description
fingerprint	String	Fingerprint of the GPG key (recommended as user ID)
keyid	String	Low 64 bits of the X.509 certificate SHA-1 fingerprint
name	String	Name associated with the GPG key
email	String	Email address associated with the GPG key

Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If you want to open a pull request, please read the contributing guidelines.

You can also support this project by becoming a sponsor on GitHub or by making a Paypal donation to ensure this journey continues indefinitely!

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.