Action to import a GPG key with environment secrets
Find a file
yanndegat 708e04fe6f
Set passphrase for all key keygrips (#57)
Co-authored-by: yann degat <yann.degat@corp.ovh.com>
2020-09-03 15:19:11 +00:00
.github Bump actions/github-script from v2 to v3 (#52) 2020-08-28 20:32:56 +00:00
__tests__ Set passphrase for all key keygrips (#57) 2020-09-03 15:19:11 +00:00
dist Add workdir input (#55) 2020-08-28 20:30:49 +00:00
node_modules Switch to Yarn 2020-06-10 22:21:27 +02:00
src Set passphrase for all key keygrips (#57) 2020-09-03 15:19:11 +00:00
.editorconfig Initial commit 2020-05-03 20:46:05 +02:00
.gitattributes Initial commit 2020-05-03 20:46:05 +02:00
.gitignore Typo 2020-05-05 21:13:56 +02:00
.prettierrc.json Codecov 2020-05-06 18:00:13 +02:00
action.yml Add workdir input (#55) 2020-08-28 20:30:49 +00:00
CHANGELOG.md Update CHANGELOG 2020-08-28 22:35:50 +02:00
jest.config.js Initial commit 2020-05-03 20:46:05 +02:00
LICENSE Initial commit 2020-05-03 20:46:05 +02:00
package.json Bump @actions/core from 1.2.4 to 1.2.5 (#53) 2020-08-28 01:17:05 +00:00
README.md Update README 2020-08-28 22:43:20 +02:00
tsconfig.json Codecov 2020-05-06 18:00:13 +02:00
yarn.lock Bump @actions/core from 1.2.4 to 1.2.5 (#53) 2020-08-28 01:17:05 +00:00

GitHub release GitHub marketplace Test workflow Codecov Become a sponsor Paypal Donate

About

GitHub Action to easily import a GPG key.

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

Import GPG


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 | sed -z 's;\n;;g' | 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@v2
        env:
          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@v2
        with:
          git_user_signingkey: true
          git_commit_gpgsign: true
        env:
          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
          PASSPHRASE: ${{ secrets.PASSPHRASE }}
      -
        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
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¹ Bool Sign all pushes automatically. (default false)
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

environment variables

Following environment variables must be used as step.env keys

Name Description
GPG_PRIVATE_KEY GPG private key exported as an ASCII armored version or its base64 encoding (required)
PASSPHRASE Passphrase of the GPG_PRIVATE_KEY key if setted

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 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.