mirror of
https://code.forgejo.org/actions/forgejo-release.git
synced 2024-12-04 15:34:47 +01:00
Manage release on a Forgejo instance
de47e391d3
Closes #14 Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/15 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: benniekiss <benniekiss@noreply.code.forgejo.org> Co-committed-by: benniekiss <benniekiss@noreply.code.forgejo.org> |
||
---|---|---|
.forgejo/workflows | ||
testdata | ||
.gitignore | ||
action.yml | ||
forgejo-release.sh | ||
LICENSE | ||
README.md |
forgejo-release
Description
Upload or download the assets of a release to a Forgejo instance.
Inputs
parameter | 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 |
Example
Upload
on: [tag]
jobs:
upload-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/forgejo-release@v1
with:
direction: upload
url: https://code.forgejo.org
release-dir: dist/release
release-notes: "MY RELEASE NOTES"
Download
Example downloading the forgejo release v1.21.4-0 into the working directory:
on: [tag]
jobs:
download-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/forgejo-release@v1
with:
direction: download
url: https://code.forgejo.org
repo: forgejo/forgejo
tag: v1.21.4-0
release-dir: ./ # by default, files are downloaded into dist/release
Update the README
With https://github.com/npalm/action-docs action-docs --update-readme