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

Add download example

Browse source
This commit is contained in:
Crown0815 2024-02-01 12:50:40 +00:00
parent ce36eb9e28
commit 38c8f4cd4d
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`