You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,14 +85,15 @@ _NOTE: set the fetch-depth for `actions/checkout@v2` or newer to be sure you ret
85
85
-**GITHUB_TOKEN****_(required)_** - Required for permission to tag the repo.
86
86
-**DEFAULT_BUMP**_(optional)_ - Which type of bump to use when none explicitly provided (default: `minor`).
87
87
-**DEFAULT_BRANCH**_(optional)_ - Overwrite the default branch its read from GitHub Runner env var but can be overwritten (default: `$GITHUB_BASE_REF`). Strongly recommended to set this var if using anything else than master or main as default branch otherwise in combination with history full will error.
88
-
-**WITH_V**_(optional)_ - Tag version with `v` character.
88
+
-**WITH_V**_(optional, depricated)_ - Tag version with `v` character. Replaced by TAG_PREFIX
89
89
-**RELEASE_BRANCHES**_(optional)_ - Comma separated list of branches (bash reg exp accepted) that will generate the release tags. Other branches and pull-requests generate versions postfixed with the commit hash and do not generate any tag. Examples: `master` or `.*` or `release.*,hotfix.*,master` ...
90
90
-**CUSTOM_TAG**_(optional)_ - Set a custom tag, useful when generating tag based on f.ex FROM image in a docker image. **Setting this tag will invalidate any other settings set!**
91
91
-**SOURCE**_(optional)_ - Operate on a relative path under $GITHUB_WORKSPACE.
92
92
-**DRY_RUN**_(optional)_ - Determine the next version without tagging the branch. The workflow can use the outputs `new_tag` and `tag` in subsequent steps. Possible values are `true` and `false` (default).
93
93
-**GIT_API_TAGGING**_(optional)_ - Set if using git cli or git api calls for tag push operations. Possible values are `false` and `true` (default).
94
-
-**INITIAL_VERSION**_(optional)_ - Set initial version before bump. Default `0.0.0`. MAKE SURE NOT TO USE vX.X.X here if combined WITH_V
94
+
-**INITIAL_VERSION**_(optional)_ - Set initial version before bump. Default `0.0.0`. MAKE SURE NOT TO USE vX.X.X here if combined TAG_PREFIX
95
95
-**TAG_CONTEXT**_(optional)_ - Set the context of the previous tag. Possible values are `repo` (default) or `branch`.
96
+
-**TAG_PREFIX**_(optional)_ - Prefix to add to the tag. eg `v` to create `v0.0.0`, WITH_V takes precidance for backwards compatibility
96
97
-**PRERELEASE**_(optional)_ - Define if workflow runs in prerelease mode, `false` by default. Note this will be overwritten if using complex suffix release branches. Use it with checkout `ref: ${{ github.sha }}` for consistency see [issue 266](https://github.com/anothrNick/github-tag-action/issues/266).
97
98
-**PRERELEASE_SUFFIX**_(optional)_ - Suffix for your prerelease versions, `beta` by default. Note this will only be used if a prerelease branch.
98
99
-**VERBOSE**_(optional)_ - Print git logs. For some projects these logs may be very large. Possible values are `true` (default) and `false`.
0 commit comments