actions/forgejo-release
1
0
Fork 0
mirror of https://code.forgejo.org/actions/forgejo-release.git synced 2025-04-24 18:02:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request 'chore: update the example to refer to v2.6.0' (#45) from wip-readme into main
Some checks are pending
/ integration (push) Waiting to run
Details

Browse source 
Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/45
This commit is contained in:
earl-warren 2025-04-12 11:28:07 +00:00
commit bc1ca37df0
No known key found for this signature in database
GPG key ID: F128CBE6AB3A7201
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -37,16 +37,18 @@ Upload or download the assets of a release to a Forgejo instance.
Upload the release located in `release-dir` to the release section of a repository (`url` and `repo`): Upload the release located in `release-dir` to the release section of a repository (`url` and `repo`):
```yaml ```yaml
on: [tag]
jobs: jobs:
upload-release: upload-release:
runs-on: ubuntu-latest runs-on: docker
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/forgejo-release@v2 - uses: actions/forgejo-release@v2.6.0
with: with:
direction: upload direction: upload
url: https://code.forgejo.org url: https://my-forgejo-instance.net
repo: myuser/myrepo
token: ${{ secrets.WRITE_TOKEN_TO_MYREPO }}
tag: v1.0.0
release-dir: dist/release release-dir: dist/release
release-notes: "MY RELEASE NOTES" release-notes: "MY RELEASE NOTES"
``` ```
@ -56,24 +58,24 @@ jobs:
Example downloading the forgejo release v1.21.4-0 into the working directory: Example downloading the forgejo release v1.21.4-0 into the working directory:
```yaml ```yaml
on: [tag]
jobs: jobs:
download-release: download-release:
runs-on: ubuntu-latest runs-on: docker
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/forgejo-release@v2 - uses: actions/forgejo-release@v2.6.0
with: with:
direction: download direction: download
url: https://code.forgejo.org url: https://my-forgejo-instance.net
repo: forgejo/forgejo repo: myuser/myrepo
tag: v1.21.4-0 token: ${{ secrets.READ_TOKEN_TO_MYREPO }}
tag: v1.0.0
release-dir: ./ # by default, files are downloaded into dist/release release-dir: ./ # by default, files are downloaded into dist/release
``` ```
### Real world example ### Real world example
This action is used to [publish](https://code.forgejo.org/forgejo/release-notes-assistant/src/branch/main/.forgejo/workflows/release.yml) the release notes assistant assets. This action is used to [publish](https://code.forgejo.org/forgejo/release-notes-assistant/src/commit/09f2c22d80d5ee655783cfeb2c1d4bab4afec3e4/.forgejo/workflows/release.yml) the release notes assistant assets.
## Update the `input` section of the README ## Update the `input` section of the README