2020-05-03 14:46:05 -04:00
[![GitHub release ](https://img.shields.io/github/release/crazy-max/ghaction-import-gpg.svg?style=flat-square )](https://github.com/crazy-max/ghaction-import-gpg/releases/latest)
[![GitHub marketplace ](https://img.shields.io/badge/marketplace-import--gpg-blue?logo=github&style=flat-square )](https://github.com/marketplace/actions/import-gpg)
2022-12-20 23:10:40 -05:00
[![Test workflow ](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-import-gpg/test.yml?branch=master&label=test&logo=github&style=flat-square )](https://github.com/crazy-max/ghaction-import-gpg/actions?workflow=test)
2020-05-06 12:06:13 -04:00
[![Codecov ](https://img.shields.io/codecov/c/github/crazy-max/ghaction-import-gpg?logo=codecov&style=flat-square )](https://codecov.io/gh/crazy-max/ghaction-import-gpg)
2020-05-03 14:46:05 -04:00
[![Become a sponsor ](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square )](https://github.com/sponsors/crazy-max)
[![Paypal Donate ](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square )](https://www.paypal.me/crazyws)
2020-08-28 16:35:50 -04:00
## About
2020-05-03 14:46:05 -04:00
2020-05-07 14:42:27 -04:00
GitHub Action to easily import a GPG key.
2020-05-03 14:46:05 -04:00
2020-05-11 13:14:35 -04:00
![Import GPG ](.github/ghaction-import-gpg.png )
2020-05-03 15:52:25 -04:00
2020-05-11 13:20:28 -04:00
___
* [Features ](#features )
* [Prerequisites ](#prerequisites )
* [Usage ](#usage )
* [Workflow ](#workflow )
* [Sign commits ](#sign-commits )
2022-03-01 04:56:11 -05:00
* [Use a subkey ](#use-a-subkey )
2023-05-06 12:20:11 -04:00
* [Set key's trust level ](#set-keys-trust-level )
2020-05-11 13:20:28 -04:00
* [Customizing ](#customizing )
* [inputs ](#inputs )
2020-08-28 16:30:49 -04:00
* [outputs ](#outputs )
2021-07-31 23:12:51 -04:00
* [Contributing ](#contributing )
2020-05-11 13:20:28 -04:00
* [License ](#license )
2020-05-04 10:17:14 -04:00
## Features
2021-09-04 19:12:28 -04:00
* Works on Linux, macOS and Windows [virtual environments ](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources )
2020-05-04 10:17:14 -04:00
* Allow to seed the internal cache of `gpg-agent` with provided passphrase
2022-02-12 13:06:41 -05:00
* Signing-only subkeys support
2020-05-05 18:23:29 -04:00
* Purge imported GPG key, cache information and kill agent from runner
2020-05-07 14:42:27 -04:00
* (Git) Enable signing for Git commits, tags and pushes
* (Git) Configure and check committer info against GPG key
2020-05-04 10:17:14 -04:00
2020-05-11 13:20:28 -04:00
## Prerequisites
2020-05-03 14:46:05 -04:00
2020-08-28 16:43:20 -04:00
First, [generate a GPG key ](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key ) and
export the GPG private key as an ASCII armored version to your clipboard:
2020-05-05 18:09:09 -04:00
```shell
2020-05-13 08:10:12 -04:00
# 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
2020-09-29 10:10:16 -04:00
gpg --armor --export-secret-key joe@foo.bar | xclip -selection clipboard -i
2020-05-13 08:10:12 -04:00
# FreeBSD (assuming BSD base64)
gpg --armor --export-secret-key joe@foo.bar | xclip
2020-05-05 18:09:09 -04:00
```
2021-08-10 02:46:50 -04:00
Paste your clipboard as a [`secret` ](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets )
named `GPG_PRIVATE_KEY` for example. Create another secret with the `PASSPHRASE` if applicable.
2020-05-05 18:09:09 -04:00
2020-05-11 13:20:28 -04:00
## Usage
### Workflow
2020-05-03 14:46:05 -04:00
```yaml
name: import-gpg
on:
push:
branches: master
jobs:
import-gpg:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2022-05-26 17:47:39 -04:00
uses: actions/checkout@v3
2020-05-03 14:46:05 -04:00
-
name: Import GPG key
2022-05-26 17:31:54 -04:00
uses: crazy-max/ghaction-import-gpg@v5
2020-09-06 16:03:16 -04:00
with:
2021-09-04 19:12:28 -04:00
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
2020-09-06 16:03:16 -04:00
passphrase: ${{ secrets.PASSPHRASE }}
2020-05-07 15:01:27 -04:00
-
2022-02-12 13:06:41 -05:00
name: List keys
run: gpg -K
2020-05-11 13:20:28 -04:00
```
### Sign commits
```yaml
name: import-gpg
on:
push:
branches: master
jobs:
sign-commit:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2022-05-26 17:47:39 -04:00
uses: actions/checkout@v3
2020-05-11 13:20:28 -04:00
-
name: Import GPG key
2022-05-26 17:31:54 -04:00
uses: crazy-max/ghaction-import-gpg@v5
2020-05-11 13:20:28 -04:00
with:
2021-09-04 19:12:28 -04:00
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
2020-09-06 16:03:16 -04:00
passphrase: ${{ secrets.PASSPHRASE }}
2021-09-04 19:12:28 -04:00
git_user_signingkey: true
git_commit_gpgsign: true
2020-05-05 19:15:33 -04:00
-
name: Sign commit and push changes
run: |
echo foo > bar.txt
git add .
git commit -S -m "This commit is signed!"
git push
2020-05-03 14:46:05 -04:00
```
2022-02-28 10:36:54 -05:00
### Use a subkey
With the input `fingerprint` , you can specify which one of the subkeys in a GPG key you want to use for signing.
```yaml
name: import-gpg
on:
push:
branches: master
jobs:
import-gpg:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2022-05-26 17:47:39 -04:00
uses: actions/checkout@v3
2022-02-28 10:36:54 -05:00
-
name: Import GPG key
2022-05-26 17:31:54 -04:00
uses: crazy-max/ghaction-import-gpg@v5
2022-02-28 10:36:54 -05:00
with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }}
fingerprint: "C17D11ADF199F12A30A0910F1F80449BE0B08CB8"
-
name: List keys
run: gpg -K
```
For example, given this GPG key with a signing subkey:
```s
pub ed25519 2021-09-24 [C]
87F257B89CE462100BEC0FFE6071D218380FDCC8
Keygrip = F5C3ABFAAB36B427FD98C4EDD0387E08EA1E8092
uid [ unknown] Joe Bar < joe @ bar . foo >
sub ed25519 2021-09-24 [S]
C17D11ADF199F12A30A0910F1F80449BE0B08CB8
Keygrip = DEE0FC98F441519CA5DE5D79773CB29009695FEB
```
You can use the subkey with signing capability whose fingerprint is `C17D11ADF199F12A30A0910F1F80449BE0B08CB8` .
2023-05-06 12:20:11 -04:00
### Set key's trust level
With the `trust_level` input, you can specify the trust level of the GPG key.
Valid values are:
* `1` : unknown
* `2` : never
* `3` : marginal
* `4` : full
* `5` : ultimate
```yaml
name: import-gpg
on:
push:
branches: master
jobs:
import-gpg:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v3
-
name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5
with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }}
trust_level: 5
```
2020-05-03 15:52:25 -04:00
## Customizing
2020-05-04 14:59:11 -04:00
### inputs
Following inputs can be used as `step.with` keys
2023-05-06 12:20:11 -04:00
| 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 |
| `trust_level` | String | Set key's trust level |
| `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 `.` ) |
| `fingerprint` | String | Specific fingerprint to use (subkey) |
> **Note**
>
2021-09-04 19:12:28 -04:00
> `git_user_signingkey` needs to be enabled for `git_commit_gpgsign`, `git_tag_gpgsign`,
> `git_push_gpgsign`, `git_committer_name`, `git_committer_email` inputs.
2020-05-07 14:42:27 -04:00
### outputs
Following outputs are available
2023-05-06 12:20:11 -04:00
| Name | Type | Description |
|---------------|--------|---------------------------------------------------------------------------------------------------------------------------------|
| `fingerprint` | String | Fingerprint of the GPG key (recommended as [user ID ](https://www.gnupg.org/documentation/manuals/gnupg/Specify-a-User-ID.html )) |
| `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 |
2020-05-04 14:59:11 -04:00
2021-07-31 23:12:51 -04:00
## Contributing
2020-08-20 11:33:24 -04:00
2021-07-31 23:12:51 -04:00
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 ](.github/CONTRIBUTING.md ).
2020-08-20 11:33:24 -04:00
2021-07-31 23:12:51 -04:00
You can also support this project by [**becoming a sponsor on GitHub** ](https://github.com/sponsors/crazy-max ) or by
making a [Paypal donation ](https://www.paypal.me/crazyws ) to ensure this journey continues indefinitely!
2020-05-03 14:46:05 -04:00
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.