Skip to content

Commit ad546e2

Browse files
authored
feature #1053 Include optional params parameter for Commits compare method (mountiny)
This PR was merged into the 3.4.x-dev branch. Discussion ---------- The Github compare API limits the response to only [250 commits](https://docs.github.com/en/rest/reference/commits#compare-two-commits). I have been testing this library and I have not been able to paginate the compare call without using the params array and adding the `per_page` key. Without it, I always got only 250 commits in the diff. When the `$params` is included, I have managed to get paginate all the commits from the Github API. Unfortunately, I cannot easily use the `all` call with the `since` parameter because I only have the base and head available. I think this change would be valuable in general, it should not break any existing behaviour and it will enable pagination for compare calls. Thank you very much for the review and considering this change, it would help a lot to our team. Commits ------- ed63fb6 Include optional params parameter for Commits compare
2 parents 37b1679 + ed63fb6 commit ad546e2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lib/Github/Api/Repository/Commits.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ public function all($username, $repository, array $params)
1616
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/commits', $params);
1717
}
1818

19-
public function compare($username, $repository, $base, $head, $mediaType = null)
19+
public function compare($username, $repository, $base, $head, $mediaType = null, array $params = [])
2020
{
2121
$headers = [];
2222
if (null !== $mediaType) {
2323
$headers['Accept'] = $mediaType;
2424
}
2525

26-
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/compare/'.rawurlencode($base).'...'.rawurlencode($head), [], $headers);
26+
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/compare/'.rawurlencode($base).'...'.rawurlencode($head), $params, $headers);
2727
}
2828

2929
public function show($username, $repository, $sha)

0 commit comments

Comments
 (0)