9
0
Fork 0
mirror of https://code.forgejo.org/actions/forgejo-release synced 2026-02-11 09:09:24 +00:00
This commit is contained in:
Niklas Koll 2026-02-09 11:02:59 +01:00
parent 94a60cb661
commit 8dc53bb34f
2 changed files with 34 additions and 0 deletions

View file

@ -18,6 +18,7 @@ Upload or download the assets of a release to a Forgejo instance.
| `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` | `""` |
| `release-notes-file` | <p>Path to a file containing your release notes (takes priority over <code>release-notes</code>)</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` | `""` |
| `gpg-passphrase` | <p>Passphrase of the GPG Private Key</p> | `false` | `""` |
@ -54,6 +55,27 @@ jobs:
release-notes: "MY RELEASE NOTES"
```
Upload a release with custom release notes located in a file:
```yaml
jobs:
upload-release:
runs-on: docker
steps:
- uses: actions/checkout@v4
- name: Generate Changelog
run: ./generate-changelog.sh > dist/changelog.md
- uses: actions/forgejo-release@v2.7.3
with:
direction: upload
url: https://my-forgejo-instance.net
repo: myuser/myrepo
token: ${{ secrets.WRITE_TOKEN_TO_MYREPO }}
tag: v13.0.2
release-dir: dist/release
release-notes-file: dist/changelog.md
```
### Download
Example downloading the forgejo release v1.21.4-0 into the working directory:

View file

@ -26,6 +26,8 @@ inputs:
default: 'dist/release'
release-notes:
description: 'Release notes'
release-notes-file:
description: 'Path to a file containing your release notes (takes priority over `release-notes`)'
direction:
description: 'Can either be `download` or `upload`'
required: true
@ -100,6 +102,16 @@ runs:
EOF
)
RELEASENOTES_FILE="${{ inputs.release-notes-file }}"
if [ ! -z "$RELEASENOTES_FILE" ]; then
if [ ! -f "$RELEASENOTES_FILE" ]; then
echo "! Release notes file $RELEASENOTES_FILE does not exist."
exit 1
fi
export RELEASENOTES=$(cat "$RELEASENOTES_FILE")
fi
export SHA="${{ inputs.sha }}"
export OVERRIDE="${{ inputs.override }}"