Autolabel new Pull Requests #29
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,14 +58,39 @@ public function handleCommentAddedEvent($issueNumber, $comment) | |
| * Adds a "Needs Review" label to new PRs. | ||
| * | ||
| * @param int $prNumber The number of the PR | ||
| * @param int $prTitle The title of the PR | ||
| * @param int $prBody The full text description of the PR | ||
| * | ||
| * @return string The new status | ||
| */ | ||
| public function handlePullRequestCreatedEvent($prNumber, $prTitle, $prBody) | ||
| { | ||
| $prLabels = array(); | ||
|
|
||
| // new PRs always require review | ||
| $newStatus = Status::NEEDS_REVIEW; | ||
| $prLabels[] = $newStatus; | ||
|
|
||
| // the PR title usually contains one or more labels | ||
| foreach ($this->extractLabels($prTitle) as $label) { | ||
| $prLabels[] = $label; | ||
| } | ||
|
|
||
| // the PR body usually indicates if this is a Bug, Feature, BC Break or Deprecation | ||
| if (preg_match('/^\|\s*Bug fix?\s*\|\s*yes\s*$/', $prBody, $matches)) { | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment.
There was a problem hiding this comment.
There was a problem hiding this comment. This is my reasoning. If some user writes this by mistake:
|
||
| $prLabels[] = 'Bug'; | ||
| } | ||
| if (preg_match('/^\|\s*New feature?\s*\|\s*yes\s*$/', $prBody, $matches)) { | ||
| $prLabels[] = 'Feature'; | ||
| } | ||
|
There was a problem hiding this comment. do we want to allow both There was a problem hiding this comment. Yes. Here it is an example: symfony/symfony#17458 |
||
| if (preg_match('/^\|\s*BC breaks?\s*\|\s*yes\s*$/', $prBody, $matches)) { | ||
| $prLabels[] = 'BC Break'; | ||
| } | ||
| if (preg_match('/^\|\s*Deprecations?\s*\|\s*yes\s*$/', $prBody, $matches)) { | ||
| $prLabels[] = 'Deprecation'; | ||
| } | ||
|
|
||
| $this->statusApi->setIssueLabels($prNumber, $prLabels); | ||
|
|
||
| return $newStatus; | ||
| } | ||
|
|
@@ -98,4 +123,40 @@ public function handleLabelAddedEvent($issueNumber, $label) | |
|
|
||
| return $newStatus; | ||
| } | ||
|
|
||
| private function extractLabels($prTitle) | ||
| { | ||
| $labels = array(); | ||
|
|
||
| // e.g. "[PropertyAccess] [RFC] [WIP] Allow custom methods on property accesses" | ||
| if (preg_match_all('/\[(?P<labels>.+)\]/U', $prTitle, $matches)) { | ||
| foreach ($matches['labels'] as $label) { | ||
| if (in_array($label, $this->getValidLabels())) { | ||
| $labels[] = $label; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $labels; | ||
| } | ||
|
|
||
| /** | ||
| * TODO: get valid labels from the repository via GitHub API | ||
| */ | ||
| private function getValidLabels() | ||
| { | ||
| return array( | ||
| 'Asset', 'BC Break', 'BrowserKit', 'Bug', 'Cache', 'ClassLoader', | ||
| 'Config', 'Console', 'Critical', 'CssSelector', 'Debug', 'DebugBundle', | ||
| 'DependencyInjection', 'Deprecation', 'Doctrine', 'DoctrineBridge', | ||
| 'DomCrawler', 'Drupal related', 'DX', 'Easy Pick', 'Enhancement', | ||
| 'EventDispatcher', 'ExpressionLanguage', 'Feature', 'Filesystem', | ||
| 'Finder', 'Form', 'FrameworkBundle', 'HttpFoundation', 'HttpKernel', | ||
| 'Intl', 'Ldap', 'Locale', 'MonologBridge', 'OptionsResolver', | ||
| 'PhpUnitBridge', 'Process', 'PropertyAccess', 'PropertyInfo', 'Ready', | ||
| 'RFC', 'Routing', 'Security', 'SecurityBundle', 'Serializer', | ||
| 'Stopwatch', 'Templating', 'Translator', 'TwigBridge', 'TwigBundle', | ||
| 'Unconfirmed', 'Validator', 'VarDumper', 'WebProfilerBundle', 'Yaml', | ||
| ); | ||
| } | ||
| } |
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
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
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
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.
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.
If we listen to this event, we should also listen for changes to the title/body after the PR was created.
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.
Probably ... but we can leave that enhancement for the future.