Add missing title input to the README (#21)

This PR adds the `title` input to the README, added in #18.

It also fixes small indentation errors that made the examples not look correctly.

Closes #20.

Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/21
Co-authored-by: Paul van Tilburg <paul@luon.net>
Co-committed-by: Paul van Tilburg <paul@luon.net>
This commit is contained in:
Paul van Tilburg 2024-08-10 05:58:49 +00:00 committed by earl-warren
parent 4cc83a59c5
commit 39501b1a89

View file

@ -13,6 +13,7 @@ Upload or download the assets of a release to a Forgejo instance.
| `url` | <p>URL of the Forgejo instance</p> | `false` | `""` | | `url` | <p>URL of the Forgejo instance</p> | `false` | `""` |
| `repo` | <p>owner/project relative to the URL</p> | `false` | `""` | | `repo` | <p>owner/project relative to the URL</p> | `false` | `""` |
| `tag` | <p>Tag of the release</p> | `false` | `""` | | `tag` | <p>Tag of the release</p> | `false` | `""` |
| `title` | <p>Title of the release</p> | `false` | `""` |
| `sha` | <p>SHA of the release</p> | `false` | `""` | | `sha` | <p>SHA of the release</p> | `false` | `""` |
| `token` | <p>Forgejo application token</p> | `true` | `""` | | `token` | <p>Forgejo application token</p> | `true` | `""` |
| `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` | | `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
@ -40,8 +41,8 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/forgejo-release@v1 - uses: actions/forgejo-release@v1
with: with:
direction: upload direction: upload
url: https://code.forgejo.org url: https://code.forgejo.org
release-dir: dist/release release-dir: dist/release
release-notes: "MY RELEASE NOTES" release-notes: "MY RELEASE NOTES"
``` ```
@ -59,8 +60,8 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/forgejo-release@v1 - uses: actions/forgejo-release@v1
with: with:
direction: download direction: download
url: https://code.forgejo.org url: https://code.forgejo.org
repo: forgejo/forgejo repo: forgejo/forgejo
tag: v1.21.4-0 tag: v1.21.4-0
release-dir: ./ # by default, files are downloaded into dist/release release-dir: ./ # by default, files are downloaded into dist/release