actions/forgejo-release
1
0
Fork 0
mirror of https://code.forgejo.org/actions/forgejo-release synced 2024-11-24 19:20:39 +00:00
Code Issues 1 Projects Releases Packages Wiki Activity Actions

Merge pull request 'Improve documentation with example for downloading a release' (#5) from Crown0815/forgejo-release:main into main

Browse source 
Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/5
Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org>
This commit is contained in:
earl-warren 2024-02-02 14:14:23 +00:00
commit 888150209e
1 changed files with 25 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -27,7 +27,9 @@ Upload or download the assets of a release to a Forgejo instance.
## Example ## Example
``` ### Upload
```yaml
on: [tag] on: [tag]
jobs: jobs:
upload-release: upload-release:
@ -42,6 +44,26 @@ jobs:
release-notes: "MY RELEASE NOTES" release-notes: "MY RELEASE NOTES"
``` ```
### Download
Example downloading the forgejo release v1.21.4-0 into the working directory:
```yaml
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 ## Update the README
With https://github.com/npalm/action-docs `action-docs --update-readme` With https://github.com/npalm/action-docs `action-docs --update-readme`