feat!: Add support for pagination options in rules API methods by ktruedat · Pull Request #3562 · google/go-github

ktruedat · 2025-04-24T10:07:57Z

BREAKING CHANGE: GetRulesForBranch, GetAllRulesets, and GetAllRepositoryRulesets now accept opts.

Updated GetRulesForBranch, GetAllRulesets, and GetAllRepositoryRulesets methods to accept optional pagination parameters (ListOptions). Enhanced test cases to validate the use of these parameters in API requests.

Fixes: #3560

Updated `GetRulesForBranch`, `GetAllRulesets`, and `GetAllRepositoryRulesets` methods to accept optional pagination parameters (`ListOptions`). Enhanced test cases to validate the use of these parameters in API requests.

codecov · 2025-04-24T10:52:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.24%. Comparing base (6a7684f) to head (3d1050a).
Report is 6 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #3562 +/- ##
==========================================
+ Coverage 91.23% 91.24% +0.01% 
==========================================
Files 183 183 Lines 16053 16075 +22 ==========================================
+ Hits 14646 14668 +22 
Misses 1231 1231 Partials 176 176

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Please make sure to run the scripts mentioned in step 4 of CONTRIBUTING.md and push the changes (not force-push) to this PR. Thank you!

gmlewis

Also, to fix the CodeCov issues, please add testBadOptions to your new tests. You can see examples in other locations.

gmlewis

Thank you, @ktruedat!
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

@stevehipwell - might you have time for a code review? Thank you!

stevehipwell

Do we not want tests to cover the case where we set opts to nil? I'd have assumed that the existing tests would use nil and new tests would have been added for the pagination pattern?

gmlewis · 2025-04-25T13:46:41Z

Testing with opts being nil sounds like a good idea in this case.
In the general case, that would be uninteresting, but it would probably be good to show it, although we still can't see how GitHub interprets the missing query parameter... so I'm fine either way.

stevehipwell · 2025-04-25T13:57:23Z

@gmlewis wouldn't testing without opts catch a regression with the method where it no longer supported nil?

gmlewis · 2025-04-25T14:00:29Z

@gmlewis wouldn't testing without opts catch a regression with the method where it no longer supported nil?

Yes, great idea. I like it. Thank you, @stevehipwell!
@ktruedat - could you please add that to this PR?

ktruedat · 2025-04-25T16:31:39Z

@gmlewis of course! I actually wanted to do separate tests from the start but wasn't sure about it. Will add them in a few

ktruedat · 2025-04-25T16:56:50Z

@gmlewis @stevehipwell I included separate tests with ListOptions for every modified operation. I didn't include the full mock response in the client response since we are not really interested in the response itself, but rather testing the existence of the query params. Let me know if that's okay, thanks!

stevehipwell

@ktruedat is there a reason the enterprise rules have been excluded from these changes? Sorry I'm only just picking this up now, but I thought I'd already checked this.

ktruedat · 2025-04-28T15:48:27Z

@ktruedat is there a reason the enterprise rules have been excluded from these changes? Sorry I'm only just picking this up now, but I thought I'd already checked this.

@stevehipwell If you are referring to the rules in enterprise_rules.go, there are no list endpoints there, and the documentation also does not mention a ListEnterpriseRules endpoint. Therefore, there is nothing to change.

stevehipwell

LGTM

gmlewis · 2025-04-28T16:08:39Z

Thank you, @stevehipwell!
Merging.

ktruedat · 2025-04-30T07:10:20Z

Thank you so much @gmlewis and @stevehipwell , I am glad I could help here! Also, if there are any other open issues that can be fixed, feel free to reach out to me, I am more than happy to contribute to this amazing repository!

gmlewis · 2025-04-30T11:49:13Z

Thank you so much @gmlewis and @stevehipwell , I am glad I could help here! Also, if there are any other open issues that can be fixed, feel free to reach out to me, I am more than happy to contribute to this amazing repository!

Thank you, @ktruedat! You are welcome to contribute to any open unassigned issue. We welcome all contributions!

…e#3562) BREAKING CHANGE: `GetRulesForBranch`, `GetAllRulesets`, and `GetAllRepositoryRulesets` now accept `opts`.

Add support for pagination options in rules API methods
e5c21cb
Updated `GetRulesForBranch`, `GetAllRulesets`, and `GetAllRepositoryRulesets` methods to accept optional pagination parameters (`ListOptions`). Enhanced test cases to validate the use of these parameters in API requests.

ktruedat mentioned this pull request Apr 24, 2025
ListOptions missing from GetAllOrganizationRulesets, Repositories.GetAllRulesets, Repositories.GetRulesForBranch functions #3560
Closed

gmlewis changed the title ~~Add support for pagination options in rules API methods~~feat!: Add support for pagination options in rules API methodsApr 24, 2025

gmlewis added NeedsReview PR is awaiting a review before merging. Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). labels Apr 24, 2025

gmlewis requested changes Apr 24, 2025
View reviewed changes

Comment threadgithub/repos_rules.go

gmlewis requested changes Apr 24, 2025
View reviewed changes

Comment threadgithub/repos_rules.go

run generate.sh and fix test coverage
9b0a5b8

gmlewis approved these changes Apr 25, 2025
View reviewed changes

stevehipwell suggested changes Apr 25, 2025
View reviewed changes

separate tests with options
3d1050a

stevehipwell suggested changes Apr 28, 2025
View reviewed changes

stevehipwell approved these changes Apr 28, 2025
View reviewed changes

gmlewis removed the NeedsReview PR is awaiting a review before merging. label Apr 28, 2025

gmlewis merged commit bdd7396 into google:masterApr 28, 2025

gmlewis mentioned this pull request May 8, 2025
Bump version of go-github to v72.0.0 #3571
Closed

jlaportebot added a commit to jlaportebot/go-github that referenced this pull request Jun 28, 2026
feat!: Add support for pagination options in rules API methods (googl…
f8582ac
…e#3562) BREAKING CHANGE: `GetRulesForBranch`, `GetAllRulesets`, and `GetAllRepositoryRulesets` now accept `opts`.

Uh oh!

Conversation

ktruedat commented Apr 24, 2025• edited by gmlewis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecovBot commented Apr 24, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Apr 25, 2025

Uh oh!

stevehipwell commented Apr 25, 2025

Uh oh!

gmlewis commented Apr 25, 2025

Uh oh!

ktruedat commented Apr 25, 2025

Uh oh!

ktruedat commented Apr 25, 2025

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

ktruedat commented Apr 28, 2025

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Apr 28, 2025

Uh oh!

ktruedat commented Apr 30, 2025

Uh oh!

gmlewis commented Apr 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ktruedat commented Apr 24, 2025•
edited by gmlewis
Loading

codecovBot commented Apr 24, 2025•
edited
Loading