Add a new boolean flag to control tag deletion

Most tags are considered immutable, so you have to explicity opt into this behaviour
This commit is contained in:
Michael Overmeyer 2021-10-25 20:12:45 -04:00
parent a80139913a
commit 1283c2357e
3 changed files with 35 additions and 0 deletions

View file

@ -174,6 +174,7 @@ The following are optional as `step.with` keys
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
| `name` | String | Name of the release. defaults to tag name |
| `tag_name` | String | Name of a tag. defaults to `github.ref` |
| `move_existing_tag` | Boolean | Indicator of whether to delete and recreate a tag if there is an existing release, with at a different `target_commitish`. Some projects consider tags to be immutable, in which case this should be kept unset/`false`. But some projects allow for some tags to be moved (e.g., `nightly`, etc.) |
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |
| `repository` | String | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable |
| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. |