actions/forgejo-release
1
0
Fork 0
mirror of https://code.forgejo.org/actions/forgejo-release.git synced 2026-02-04 14:58:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: lint and fix

Browse source
This commit is contained in:
Michael Kriese 2026-01-21 10:34:03 +01:00
parent b93b6e8f70
commit 7556e6fc5f
No known key found for this signature in database
GPG key ID: F8D7748549A5986A
3 changed files with 29 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -10,13 +10,13 @@ Upload or download the assets of a release to a Forgejo instance.
| name | description | required | default |
| --- | --- | --- | --- |
| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.GITHUB_SERVER_URL }}` |
| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ github.repository }}` |
| `tag` | <p>Tag of the release</p> | `false` | `${{ github.ref_name }}` |
| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.FORGEJO_SERVER_URL }}` |
| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ forge.repository }}` |
| `tag` | <p>Tag of the release</p> | `false` | `${{ forge.ref_name }}` |
| `title` | <p>Title of the release (defaults to tag)</p> | `false` | `""` |
| `sha` | <p>SHA of the release</p> | `false` | `${{ github.sha }}` |
| `token` | <p>Forgejo application token (must have `write:repository`)</p> | `false` | `${{ secrets.GITHUB_TOKEN }}` |
| `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
| `sha` | <p>SHA of the release</p> | `false` | `${{ forge.sha }}` |
| `token` | <p>Forgejo application token (must have <code>write:repository</code>)</p> | `false` | `${{ forge.token }}` |
| `release-dir` | <p>Directory in which release assets are uploaded or downloaded</p> | `false` | `dist/release` |
| `release-notes` | <p>Release notes</p> | `false` | `""` |
| `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |
| `gpg-private-key` | <p>GPG Private Key to sign the release artifacts</p> | `false` | `""` |
@ -28,6 +28,7 @@ Upload or download the assets of a release to a Forgejo instance.
| `prerelease` | <p>Mark Release as Pre-Release</p> | `false` | `false` |
| `release-notes-assistant` | <p>Generate release notes with Release Notes Assistant</p> | `false` | `false` |
| `hide-archive-link` | <p>Hide the archive links</p> | `false` | `false` |
| `skip-assets` | <p>Skip uploading release assets</p> | `false` | `false` |
<!-- action-docs-inputs source="action.yml" -->
## Examples
@ -83,5 +84,5 @@ Using [action-docs](https://github.com/npalm/action-docs):
```shell
# Edit the action.yml file and run:
action-docs --update-readme
npx action-docs --update-readme
```