add note on potential override pitfalls

This commit is contained in:
benniekiss 2024-11-10 11:27:54 -05:00
parent ec4a3e9cf2
commit 6bfd194b7a

View file

@ -28,6 +28,14 @@ Upload or download the assets of a release to a Forgejo instance.
| `prerelease` | <p>Mark Release as Pre-Release</p> | `false` | `false` | | `prerelease` | <p>Mark Release as Pre-Release</p> | `false` | `false` |
<!-- action-docs-inputs source="action.yml" --> <!-- action-docs-inputs source="action.yml" -->
#### Note on `override`:
The `override` option can lead to unexpected results when the workflow is triggered by `on: release` or `on: push: tags`.
The `on: release` workflow trigger should be avoided when setting the `override` option because it will cause an infinite loop of workflows when the release is overriden.
The `override` option not only overrides an existing release, it will also recreate the tag if the `SHA` which triggered the workflow does not match the `SHA` of the existing release. Care should be taken when the workflow is triggered by `on: push: tags`, as this can potentially cause an infinite loop if the tag is recreated.
## Examples ## Examples
### Upload ### Upload