feat: add regex support to scope configuration #226
Merged
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
amannn
reviewed
Feb 10, 2023
README.md
Outdated
| scopes: | | ||
| core | ||
| ui | ||
| (?![A-Z])+ |
There was a problem hiding this comment.
Should we maybe use the JIRA ID use case here? It seems like many users are interested in that.
There was a problem hiding this comment.
That's a good idea
Do you think something somewhat specific like JIRA-\d+ would be sufficient? To draw the eye with the JIRA part (that people can replace for their own project)?
amannn
reviewed
Feb 10, 2023
amannn
approved these changes
Feb 10, 2023
|
🎉 This PR is included in version 5.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
6 tasks
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.
Reasoning
I would like to use this github action for PR validation in my project. It would be good as is, but we have adopted a convention where the
scopeincludes a JIRA ticket ID, which in combination with github's auto-linking feature works wonders for readable changelogs. However, without regex support it's not possible to validate such scope.I have also noticed that and issue for this already exists: Closes #221
Changes
I've changed existing fields for scope configuration (
scopes,disallowedScopes) to be based around Regex, inspired by the solution for thetypesproposed in #220My reasoning behind it was, that adding separate
scopePatterninput would be a bit confusing, and would add configurational complexity with then having to ignore/throw on e.g.scopesbeing declared as well.To ensure backwards compatibilty I made it so the regex is auto-wrapped in
^ $. This can be problematic if someone doesn't want to match it from start to end, but can be worked around. I've also included tests to ensure double wrapping is not an issue.I've included unit tests, tried to make it explicit with backwards compatibility.
Let me know if this makes sense :)
Demo PR
Kretolus#1