mirror of
https://code.forgejo.org/actions/forgejo-release.git
synced 2025-04-24 18:02:15 +00:00
Chore: document default values
This commit is contained in:
parent
b8d80407e0
commit
e96cb854f9
1 changed files with 5 additions and 5 deletions
10
README.md
10
README.md
|
@ -10,12 +10,12 @@ Upload or download the assets of a release to a Forgejo instance.
|
||||||
|
|
||||||
| name | description | required | default |
|
| name | description | required | default |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `url` | <p>URL of the Forgejo instance</p> | `false` | `""` |
|
| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.GITHUB_SERVER_URL }}` |
|
||||||
| `repo` | <p>owner/project relative to the URL</p> | `false` | `""` |
|
| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ github.repository }}` |
|
||||||
| `tag` | <p>Tag of the release</p> | `false` | `""` |
|
| `tag` | <p>Tag of the release</p> | `false` | `${{ github.ref_name }}` |
|
||||||
| `title` | <p>Title of the release (defaults to tag)</p> | `false` | `""` |
|
| `title` | <p>Title of the release (defaults to tag)</p> | `false` | `""` |
|
||||||
| `sha` | <p>SHA of the release</p> | `false` | `""` |
|
| `sha` | <p>SHA of the release</p> | `false` | `${{ github.sha }}` |
|
||||||
| `token` | <p>Forgejo application token</p> | `true` | `""` |
|
| `token` | <p>Forgejo application token</p> | `false` | `${{ secrets.GITHUB_TOKEN }}` |
|
||||||
| `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` | `""` |
|
||||||
| `release-notes` | <p>Release notes</p> | `false` | `""` |
|
| `release-notes` | <p>Release notes</p> | `false` | `""` |
|
||||||
| `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |
|
| `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |
|
||||||
|
|
Loading…
Add table
Reference in a new issue