Update README.md

This commit is contained in:
Santiago Lo Coco 2022-03-03 11:11:31 -03:00 committed by GitHub
parent 2afde37589
commit e3571a2bb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions

View File

@ -4,19 +4,19 @@ GitHub action to build a package, analyze it with `namcap`, and output the packa
This action supports PKGBUILDs that have AUR dependencies. This action supports PKGBUILDs that have AUR dependencies.
## Table of contents ## Table of contents
- [Inputs and outputs <a name="inputs-and-outputs-"></a>](#inputs-and-outputs--) - [Inputs and outputs <a name="inputs-and-outputs-"></a>](#inputs-and-outputs-)
- [Usage <a name="usage"></a>](#usage-) - [Usage <a name="usage"></a>](#usage-)
- [Contributing <a name="contributing"></a>](#contributing-) - [Contributing <a name="contributing"></a>](#contributing-)
- [License <a name="license"></a>](#license-) - [License <a name="license"></a>](#license-)
## Inputs and outputs <a name="inputs-and-outputs-"></a> ## Inputs and outputs <a name="inputs-and-outputs-"></a>
### Inputs: ### Inputs:
* `pkgDir`: PKGBUILD directory relative path. * `pkgDir`: relative path to the PKGBUILD directory.
* `gpgPublicKey`: GPG public key that will be used to sign packages. * `gpgPublicKey`: GPG public key that will be used to sign packages.
* `gpgPrivateKey`: GPG private key. * `gpgPrivateKey`: GPG private key.
* `gpgPassphrase`: The GPG passphrase for the `gpgPrivateKey`. * `gpgPassphrase`: GPG passphrase of `gpgPrivateKey`.
It is recommended that you store the `gpgPrivateKey` and the `gpgPassphrase` as secrets (see [Usage <a name="usage"></a>](#usage-)). It is recommended to store `gpgPrivateKey` and `gpgPassphrase` as secrets (see [Usage](#usage-)).
None of these inputs are required. None of these inputs are required.