Add "v" prefix to changelog generation regex #10
Merged
Conversation
This file contains hidden or 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
The repository's existing tags use the style where the name is identical to the version name. The `arduino/create-changelog` action's `tag-regex` input value is currently configured for this tag style. That is correct for the previous tags, but all future tags will use the "v" prefix, as is required for best practices use of the project as a Go module dependency. This will result in the generated changelog for future releases containing the repository's commit history back to the last tag that uses the non-"v" prefix style of tag. Setting the regex up to support both tag styles will avoid such an issue.
per1234
added
type: enhancement
cmaglie
approved these changes
Aug 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The repository's existing tags use the style where the name is identical to the version name. The
arduino/create-changelogaction'stag-regexinput value is currently configured for this tag style. That is correct for the previous tags, but all future tags will use the "v" prefix, as is required for best practices use of the project as a Go module dependency. This will result in the generated changelog for future releases containing the repository's commit history back to the last tag that uses the non-"v" prefix style of tag.Setting the regex up to support both tag styles will avoid such an issue.
Demo release using the updated workflow: https://github.com/per1234/mdns-discovery/releases/tag/v1.4.2