Added TAG_PREFIX so more descriptive tags can be used #326
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timothyclarke
changed the title
|
@anothrNick When you get a chance can you take a look at this one please |
|
Hi @anothrNick , this feature would be great for working with monorepos. |
robw-raviga
reviewed
Jan 24, 2025
README.md
Outdated
| @@ -85,14 +84,15 @@ _NOTE: set the fetch-depth for `actions/checkout@v2` or newer to be sure you ret | |||
| - **GITHUB_TOKEN** **_(required)_** - Required for permission to tag the repo. | |||
| - **DEFAULT_BUMP** _(optional)_ - Which type of bump to use when none explicitly provided (default: `minor`). | |||
| - **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. | |||
| - **WITH_V** _(optional)_ - Tag version with `v` character. | |||
| - **WITH_V** _(optional, depricated)_ - Tag version with `v` character. Replaced by TAG_PREFIX | |||
There was a problem hiding this comment.
Suggested change
| - **WITH_V** _(optional, depricated)_ - Tag version with `v` character. Replaced by TAG_PREFIX | |
| - **WITH_V** _(optional, deprecated)_ - Tag version with `v` character. Replaced by TAG_PREFIX |
There was a problem hiding this comment.
@robw-raviga Thanks. Fixed in ed6507f
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
Added
TAG_PREFIXto replaceWITH_V.WITH_Vis still in place for backwards comparability, but the idea is it would be removed in a few versions (gives people a chance to change their code, doesn't force a major etc)This should fix #320. I have a similar use case where a monorepo has a bunch of folders which maintain independent versions
This is best used along side changed-files and a matrix
Breaking Changes
Do any of the included changes break current behaviour or configuration?
NO : The changes are backwards compatible to allow a smoother transition
How changes have been tested
Backwards compatibility
tagging WITH_V false
tagging WITH_V true
New Feature (all in matrix jobs as that's my usecase)
Bump multiple tags
Bump one tag add one tag
List any unknowns