Skip to content

Commit 0b5cd52

Browse files
authored
Merge pull request #606 from Geolim4/master
Added dismissal review mandatory "message" parameter
2 parents aa4e285 + 18e88bb commit 0b5cd52

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

lib/Github/Api/PullRequest/Review.php

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,22 @@ public function submit($username, $repository, $pullRequest, $id, array $params
159159
* @param string $repository the repository
160160
* @param int $pullRequest the pull request number
161161
* @param int $id the review id
162+
* @param string $message a mandatory dismissal message
162163
*
163164
* @return array|string
164165
*/
165-
public function dismiss($username, $repository, $pullRequest, $id)
166+
public function dismiss($username, $repository, $pullRequest, $id, $message)
166167
{
167-
return $this->put('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.$pullRequest.'/reviews/'.$id.'/dismissals');
168+
if (!is_string($message)) {
169+
throw new InvalidArgumentException(sprintf('"message" must be a valid string ("%s" given).', gettype($message)));
170+
}
171+
172+
if (empty($message)) {
173+
throw new InvalidArgumentException('"message" is mandatory and cannot be empty');
174+
}
175+
176+
return $this->put('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.$pullRequest.'/reviews/'.$id.'/dismissals', [
177+
'message' => $message
178+
]);
168179
}
169180
}

test/Github/Tests/Api/PullRequest/ReviewTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ public function shouldDismissReview()
391391
->with('/repos/octocat/Hello-World/pulls/12/reviews/80/dismissals')
392392
->willReturn($expectedValue);
393393

394-
$this->assertSame($expectedValue, $api->dismiss('octocat', 'Hello-World', 12, 80));
394+
$this->assertSame($expectedValue, $api->dismiss('octocat', 'Hello-World', 12, 80, 'Dismiss reason'));
395395
}
396396

397397
protected function getApiClass()

0 commit comments

Comments
 (0)