diff --git a/README.md b/README.md index 4c52ba8..e020a8a 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,12 @@ Upload or download the assets of a release to a Forgejo instance. | `prerelease` |

Mark Release as Pre-Release

| `false` | `false` | -## Example +## Examples ### Upload +Upload the release located in `release-dir` to the release section of a repository (`url` and `repo`): + ```yaml on: [tag] jobs: @@ -39,7 +41,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: actions/forgejo-release@v1 + - uses: actions/forgejo-release@v2 with: direction: upload url: https://code.forgejo.org @@ -58,7 +60,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: actions/forgejo-release@v1 + - uses: actions/forgejo-release@v2 with: direction: download url: https://code.forgejo.org @@ -67,6 +69,15 @@ jobs: release-dir: ./ # by default, files are downloaded into dist/release ``` -## Update the README +### Real world example -With https://github.com/npalm/action-docs `action-docs --update-readme` +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. + +## Update the `input` section of the README + +Using [action-docs](https://github.com/npalm/action-docs): + +```shell +# Edit the action.yml file and run: +action-docs --update-readme +```