doc: add outputs

This commit is contained in:
Michael Sasser 2024-12-27 15:39:35 +01:00
parent fd4709f6fb
commit 9333321782
Signed by: michael
GPG key ID: 5F653AC7631F5151

View file

@ -6,7 +6,7 @@ container, like the one we provide at
with all the necessary tools. Alternatively you could install the necessary with all the necessary tools. Alternatively you could install the necessary
tools yourself before running this action. tools yourself before running this action.
## inputs ## Inputs
| Name | Default | Required | Description | | Name | Default | Required | Description |
| ------------------------- | -------- | -------- | ------------------------------------------------ | | ------------------------- | -------- | -------- | ------------------------------------------------ |
@ -16,6 +16,12 @@ tools yourself before running this action.
| `install_package` | `'true'` | No | Install the package after it was built | | `install_package` | `'true'` | No | Install the package after it was built |
| `lint_package` | `'true'` | No | Run namecap on the resulting package | | `lint_package` | `'true'` | No | Run namecap on the resulting package |
## Outputs
| Name | Description |
| --------- | ------------------------------------------------- |
| `package` | The name of the package file built by this action |
## Example usage ## Example usage
```yaml ```yaml
@ -45,6 +51,5 @@ follows the
## License ## License
Copyright &copy; 2020-2001 Michael Sasser <Info@MichaelSasser.org>. Released Copyright &copy; 2024 Michael Sasser <Info@MichaelSasser.org>. Released under
under the MIT license. the MIT license.