diff --git a/README.md b/README.md index d8c397a..13e5aac 100644 --- a/README.md +++ b/README.md @@ -8,22 +8,23 @@ Upload or download the assets of a release to a Forgejo instance. ## Inputs -| parameter | description | required | default | +| name | description | required | default | | --- | --- | --- | --- | -| url | URL of the Forgejo instance | `false` | | -| repo | owner/project relative to the URL | `false` | | -| tag | Tag of the release | `false` | | -| sha | SHA of the release | `false` | | -| token | Forgejo application token | `true` | | -| release-dir | Directory in whichs release assets are uploaded or downloaded | `true` | | -| release-notes | Release notes | `false` | | -| direction | Can either be download or upload | `true` | | -| gpg-private-key | GPG Private Key to sign the release artifacts | `false` | | -| gpg-passphrase | Passphrase of the GPG Private Key | `false` | | -| download-retry | Number of times to retry if the release is not ready (default 1) | `false` | | -| verbose | Increase the verbosity level | `false` | false | -| override | Override an existing release by the same {tag} | `false` | false | -| prerelease | Mark Release as Pre-Release | `false` | false | +| `url` |
URL of the Forgejo instance
| `false` | `""` | +| `repo` |owner/project relative to the URL
| `false` | `""` | +| `tag` |Tag of the release
| `false` | `""` | +| `sha` |SHA of the release
| `false` | `""` | +| `token` |Forgejo application token
| `true` | `""` | +| `release-dir` |Directory in whichs release assets are uploaded or downloaded
| `true` | `""` | +| `release-notes` |Release notes
| `false` | `""` | +| `direction` |Can either be download or upload
| `true` | `""` | +| `gpg-private-key` |GPG Private Key to sign the release artifacts
| `false` | `""` | +| `gpg-passphrase` |Passphrase of the GPG Private Key
| `false` | `""` | +| `download-retry` |Number of times to retry if the release is not ready (default 1)
| `false` | `""` | +| `download-latest` |Download the latest release
| `false` | `false` | +| `verbose` |Increase the verbosity level
| `false` | `false` | +| `override` |Override an existing release by the same {tag}
| `false` | `false` | +| `prerelease` |Mark Release as Pre-Release
| `false` | `false` | ## Example