mirror of
https://code.forgejo.org/actions/forgejo-release.git
synced 2026-05-06 18:47:35 +02:00
feat: release notes from file (#141)
Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/141 Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: nihklas <nihklas@noreply.code.forgejo.org> Co-committed-by: nihklas <nihklas@noreply.code.forgejo.org>
This commit is contained in:
parent
94a60cb661
commit
8fb94f88a4
9 changed files with 125 additions and 0 deletions
22
README.md
22
README.md
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue