Include optional params parameter for Commits compare method #1053
Conversation
This file contains 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
With the current API, we cannot paginate compare basehead function call. The Github API limits the response to only 250 commits so for larger diffs we have no option.
|
@acrobat any thoughts on this one? We would find this update quite handy and it should not break any existing code. |
|
Thanks @mountiny, sorry for the delay! And congrats on your first contribution! 🎉 |
|
No worries! Thakn you! |
|
@acrobat Any estimates for next release with this PR included? Thanks! |
|
@mountiny I've just released a new version, see https://github.com/KnpLabs/php-github-api/releases/tag/v3.6.0 |
|
Legend! Thanks! @acrobat |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Github compare API limits the response to only 250 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_pagekey. Without it, I always got only 250 commits in the diff.When the
$paramsis included, I have managed to get paginate all the commits from the Github API.Unfortunately, I cannot easily use the
allcall with thesinceparameter 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.