-
Notifications
You must be signed in to change notification settings - Fork 13.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add breaking change to title regex #12754
chore: add breaking change to title regex #12754
Conversation
Codecov Report
@@ Coverage Diff @@
## master #12754 +/- ##
==========================================
- Coverage 66.68% 64.16% -2.52%
==========================================
Files 1021 488 -533
Lines 50008 30403 -19605
Branches 4905 0 -4905
==========================================
- Hits 33346 19508 -13838
+ Misses 16532 10895 -5637
+ Partials 130 0 -130
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
The prefixes are task types. "Breaking change" sounds more like a flag or label. Conventional commits specifies breaking changes should add
or
I think it'd be worthwhile following the best practices from the community. |
Thanks, this is a good resource @ktmud. |
@@ -19,7 +19,7 @@ jobs: | |||
submodules: recursive | |||
- uses: ./.github/actions/pr-lint-action | |||
with: | |||
title-regex: "^(build|chore|ci|docs|feat|fix|perf|refactor|style|test|other)((.+))?:\\s.+" | |||
title-regex: "^(build|chore|ci|docs|feat|fix|perf|refactor|style|test|other)(\\(.+\\))?(\\!)?:\\s.+" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nytai I escaped the parens here.. was that intentional originally? Also, do you know the reason for the last s
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, I'm also a little confused by this regex. I lifted it from this file https://github.com/apache/superset/blob/dc893fe1b3b86e2921bb77e08a531db46b3f8e5d/.github/prlint.json
that @mistercrunch added
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, this is making more sense now. Looks like there's some yaml escaping in here too. I'm seeing there was a mistake in the original parens, so the previous regex allowed anything after the prefix and before the :
, so buildskjdsfsdfsdbjfds: dsfds
would have been valid 🤣. The last \s
is the ensure there's white space after the :
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, gotcha. yeah, the yaml escaping threw me off on the \\s
at first too. Luckily the linter caught the new ones.
rebuilding |
SUMMARY
Per #12566 [SIP 57] adding a regex check to allow for a title that has a
breaking-change
prefix. Authors should use this prefix for any fixes, features, perf, refactor, etc that is a breaking change.ADDITIONAL INFORMATION