chore(prlint): all prefixes must be lowercase + better failure message #33102
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33102 +/- ##
=======================================
Coverage 81.54% 81.54%
=======================================
Files 226 226
Lines 13777 13777
Branches 2414 2414
=======================================
Hits 11235 11235
Misses 2270 2270
Partials 272 272
Flags with carried forward coverage won't be shown. Click here to find out more.
|
tools/@aws-cdk/prlint/lint.ts
Outdated
| @@ -401,11 +401,11 @@ function validateBreakingChangeFormat(pr: GitHubPr, _files: GitHubFile[]): TestR | |||
| */ | |||
| function validateTitlePrefix(pr: GitHubPr): TestResult { | |||
| const result = new TestResult(); | |||
| const titleRe = /^(feat|fix|build|chore|ci|docs|style|refactor|perf|test|(r|R)evert)(\([\w_-]+\))?: /; | |||
| const titleRe = /^(feat|fix|build|chore|ci|docs|style|refactor|perf|test|revert)(\([\w_-]+\))?: /; | |||
There was a problem hiding this comment.
nit
| const titleRe = /^(feat|fix|build|chore|ci|docs|style|refactor|perf|test|revert)(\([\w_-]+\))?: /; | |
| const validTypes = "feat|fix|build|chore|ci|docs|style|refactor|perf|test|(r|R)evert"; | |
| const titleRe = new RegExp(`^(${validTypes})(\\([\\w_-]+\\))?: `); | |
| ... | |
| `The title prefix of this pull request must be one of "${validTypes}"` |
There was a problem hiding this comment.
much better! thank you!
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
This pull request has been removed from the queue for the following reason: Pull request #33102 has been dequeued. The pull request has been synchronized by a user You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it. If you want to requeue this pull request, you need to post a comment with the text: |
|
@Mergifyio requeue |
✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
Updates the PR linter to remove
Revertas a valid title prefix, in favor ofrevert. To be fair, this is a stylistic change, but I think its unclean to have every other valid prefix as lowercase except forRevert. The reason is because github automatically titles revert PRs withRevert, but I don't think it's much effort for engineers to update the title so it fits in the style with everything else.In addition, I've updated the failure message to make it clear what it's looking for, rather than a link to conventionalcommits.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license