diff --git a/README.md b/README.md index e879520..8c1d2f0 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,14 @@ Upload or download the assets of a release to a Forgejo instance. | `prerelease` |
Mark Release as Pre-Release
| `false` | `false` | +#### 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 ### Upload