Update README.md

This commit is contained in:
Santiago Lo Coco 2023-10-07 15:46:58 -03:00
parent 30d6d7fa4e
commit 5d48e7b1ec
1 changed files with 8 additions and 8 deletions

View File

@ -4,12 +4,12 @@ Woodpecker action to build a package, analyze it with `namcap`, and output the p
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](#inputs-and-outputs-)
- [Usage <a name="usage"></a>](#usage-) - [Usage](#usage-)
- [Contributing <a name="contributing"></a>](#contributing-) - [Contributing](#contributing-)
- [License <a name="license"></a>](#license-) - [License](#license-)
## Inputs and outputs <a name="inputs-and-outputs-"></a> ## Inputs and outputs
### Inputs: ### Inputs:
* `pkgDir`: relative path to the PKGBUILD directory. * `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.
@ -24,7 +24,7 @@ None of these inputs are required.
* `srcInfo`: Generated `.SRCINFO`. * `srcInfo`: Generated `.SRCINFO`.
* `pkgFile`: Built package file. * `pkgFile`: Built package file.
## Usage <a name="usage"></a> ## Usage
```yaml ```yaml
steps: steps:
webhook: webhook:
@ -38,8 +38,8 @@ steps:
from_secret: GPG_PASSPHRASE from_secret: GPG_PASSPHRASE
``` ```
## Contributing <a name="contributing"></a> ## Contributing
PRs are welcome. PRs are welcome.
## License <a name="license"></a> ## License
[MIT](https://git.slc.ar/slococo/calbuilder/src/branch/master/LICENSE.md) [MIT](https://git.slc.ar/slococo/calbuilder/src/branch/master/LICENSE.md)