actions/gpg
1
0
Fork 0
mirror of https://github.com/crazy-max/ghaction-import-gpg.git synced 2024-11-22 04:50:56 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #184 from crazy-max/bump-major

Browse source 
docs: bump actions to latest major
This commit is contained in:
CrazyMax 2023-09-10 15:27:24 +02:00 committed by GitHub
commit 232931e03b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -29,7 +29,7 @@ ___
## Features ## Features
* 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) * 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)
* Allow to seed the internal cache of `gpg-agent` with provided passphrase * Allow seeding the internal cache of `gpg-agent` with provided passphrase
* Signing-only subkeys support * Signing-only subkeys support
* Purge imported GPG key, cache information and kill agent from runner * Purge imported GPG key, cache information and kill agent from runner
* (Git) Enable signing for Git commits, tags and pushes * (Git) Enable signing for Git commits, tags and pushes
@ -55,7 +55,8 @@ gpg --armor --export-secret-key joe@foo.bar | xclip
``` ```
Paste your clipboard as a [`secret`](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) 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. named `GPG_PRIVATE_KEY` for example. Create another secret with the
`PASSPHRASE` if applicable.
## Usage ## Usage
@ -74,10 +75,10 @@ jobs:
steps: steps:
- -
name: Checkout name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v4
- -
name: Import GPG key name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5 uses: crazy-max/ghaction-import-gpg@v6
with: with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
@ -101,10 +102,10 @@ jobs:
steps: steps:
- -
name: Checkout name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v4
- -
name: Import GPG key name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5 uses: crazy-max/ghaction-import-gpg@v6
with: with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
@ -121,7 +122,8 @@ jobs:
### Use a subkey ### 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. With the input `fingerprint`, you can specify which one of the subkeys in a GPG
key you want to use for signing.
```yaml ```yaml
name: import-gpg name: import-gpg
@ -136,10 +138,10 @@ jobs:
steps: steps:
- -
name: Checkout name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v4
- -
name: Import GPG key name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5 uses: crazy-max/ghaction-import-gpg@v6
with: with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
@ -151,7 +153,7 @@ jobs:
For example, given this GPG key with a signing subkey: For example, given this GPG key with a signing subkey:
```s ```
pub ed25519 2021-09-24 [C] pub ed25519 2021-09-24 [C]
87F257B89CE462100BEC0FFE6071D218380FDCC8 87F257B89CE462100BEC0FFE6071D218380FDCC8
Keygrip = F5C3ABFAAB36B427FD98C4EDD0387E08EA1E8092 Keygrip = F5C3ABFAAB36B427FD98C4EDD0387E08EA1E8092
@ -187,10 +189,10 @@ jobs:
steps: steps:
- -
name: Checkout name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v4
- -
name: Import GPG key name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5 uses: crazy-max/ghaction-import-gpg@v6
with: with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
@ -201,7 +203,7 @@ jobs:
### inputs ### inputs
Following inputs can be used as `step.with` keys The following inputs can be used as `step.with` keys
| Name | Type | Description | | Name | Type | Description |
|-----------------------|--------|--------------------------------------------------------------------------------------------| |-----------------------|--------|--------------------------------------------------------------------------------------------|
@ -236,11 +238,10 @@ Following outputs are available
## Contributing ## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If Want to contribute? Awesome! The most basic way to show your support is to star
you want to open a pull request, please read the [contributing guidelines](.github/CONTRIBUTING.md). the project, or to raise issues. 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
You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) or by journey continues indefinitely!
making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray: Thanks again for your support, it is much appreciated! :pray: