refactor!: Change `GitService` methods to pass required params by-value instead of by-ref by rupokghosh · Pull Request #3654 · google/go-github

rupokghosh · 2025-07-27T21:30:44Z

BREAKING CHANGE: GitService methods now pass required params by-value instead of by-ref.

What problem are you solving?

Related to Refactor codebase to use value parameters instead of pointers where appropriate #3644
Convert parameters to values instead of pointers wherever appropriate. This eliminates nil pointer errors for required inputs and improves API clarity by using value semantics for immutable, required data.

Notes

This is most likely going to be a multi PR issue, since this is my first time working on this codebase. I started by picking a "service" area ( Git ) and converted each function that I thought met the criteria set in the issue mentioned, which are:

The input is required (not optional)
The function does not modify the input

gmlewis · 2025-07-27T22:53:14Z

Please follow step 4 in CONTRIBUTING.md and push the changes to this PR.

rupokghosh · 2025-07-28T01:27:54Z

done ✔️ @gmlewis

codecov · 2025-07-28T11:37:32Z

Codecov Report

❌ Patch coverage is 64.00000% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.20%. Comparing base (17f7ee4) to head (92a65bb).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
example/commitpr/main.go	0.00%	6 Missing ⚠️
github/git_refs.go	80.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## master #3654 +/- ##
==========================================
- Coverage 91.25% 91.20% -0.05% 
==========================================
Files 185 185 Lines 16378 16360 -18 ==========================================
- Hits 14945 14921 -24 - Misses 1249 1254 +5 - Partials 184 185 +1

☔ 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

Thank you, @rupokghosh!
LGTM.

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

alexandear · 2025-08-04T12:37:45Z

Please extend the PR header to mention that only GitService is affected by this PR.

gmlewis · 2025-08-04T12:44:41Z

@alexandear - how's that?

gmlewis · 2025-08-04T12:45:39Z

Whups, I think "methods" is better than "endpoints", agreed?

update exmaples change to using values refactor(git)!: improve CreateRef API with value types and exported struct format new updateref struct remove backwards compatibility create tag in git tags slfhg

rupokghosh · 2025-08-04T18:52:10Z

let me know if we can merge this in now!

gmlewis

Thank you, @rupokghosh and @alexandear!
LGTM.
Merging.

…Release Introduce dedicated CreateReleaseRequest and UpdateReleaseRequest types for the bodies of RepositoriesService.CreateRelease and RepositoriesService.UpdateRelease, replacing the *RepositoryRelease parameter that also carried response-only fields. The new types are passed by value and serialized directly, dropping the internal repositoryReleaseRequest remap. EditRelease is renamed to UpdateRelease for naming consistency. This follows the value-parameter pattern established by the merged google#3654, google#3794 and google#4320, the Edit -> Update rename from google#4320, and the dedicated *Request body convention already used across the package (e.g. CreateHostedRunnerRequest). The runtime nil checks are removed since a value parameter makes them unnecessary. No deprecated wrappers are added (clean break). Updates google#3644. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

…Release Introduce dedicated CreateReleaseRequest and UpdateReleaseRequest types for the bodies of RepositoriesService.CreateRelease and RepositoriesService.UpdateRelease, replacing the *RepositoryRelease parameter that also carried response-only fields. The new types are passed by value and serialized directly, dropping the internal repositoryReleaseRequest remap. EditRelease is renamed to UpdateRelease for naming consistency. This follows the value-parameter pattern established by the merged google#3654, google#3794 and google#4320, the Edit -> Update rename from google#4320, and the dedicated *Request body convention already used across the package (e.g. CreateHostedRunnerRequest). The runtime nil checks are removed since a value parameter makes them unnecessary. No deprecated wrappers are added (clean break). Updates google#3644.

…ue instead of by-ref (google#3654) BREAKING CHANGE: `GitService` methods now pass required params by-value instead of by-ref.

rupokghosh marked this pull request as ready for review July 27, 2025 21:32

gmlewis changed the title ~~refactor: convert required pointer params to values~~refactor: Change required params from pointers to valuesJul 27, 2025

rupokghosh force-pushed the rupok/change-pointer-params-to-values branch from d124f0e to 826440eCompare July 28, 2025 01:26

alexandear reviewed Jul 28, 2025
View reviewed changes

Comment threadexample/commitpr/main.go Outdated
Comment threadexample/commitpr/main.go Outdated

alexandear reviewed Jul 28, 2025
View reviewed changes

Comment threadgithub/git_refs.go Outdated

alexandear mentioned this pull request Jul 28, 2025
refactor: Fix gocritic.paramTypeCombine lint issues #3655
Merged

gmlewis added the Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). label Jul 31, 2025

gmlewis changed the title ~~refactor: Change required params from pointers to values~~refactor!: Change required params from pointers to valuesJul 31, 2025

rupokghosh force-pushed the rupok/change-pointer-params-to-values branch 2 times, most recently from 64a09b4 to d813b23Compare August 2, 2025 22:23

rupokghosh requested review from alexandear and gmlewis August 2, 2025 22:26

gmlewis added the NeedsReview PR is awaiting a review before merging. label Aug 2, 2025

gmlewis approved these changes Aug 2, 2025
View reviewed changes

gmlewis changed the title ~~refactor!: Change required params from pointers to values~~refactor!: Change GitService endpoints to pass required params by-value instead of by-refAug 4, 2025

gmlewis changed the title ~~refactor!: Change GitService endpoints to pass required params by-value instead of by-ref~~refactor!: Change GitService methods to pass required params by-value instead of by-refAug 4, 2025

alexandear suggested changes Aug 4, 2025
View reviewed changes

Comment threadgithub/git_refs.go Outdated
Comment threadgithub/git_refs.go Outdated
Comment threadgithub/git_tags.go Outdated

rupokghosh force-pushed the rupok/change-pointer-params-to-values branch from d813b23 to 939e78aCompare August 4, 2025 14:36

rupokghosh requested review from alexandear and gmlewis August 4, 2025 14:36

alexandear approved these changes Aug 4, 2025
View reviewed changes

gmlewis removed the NeedsReview PR is awaiting a review before merging. label Aug 4, 2025

refactor: convert required pointer params to values
92a65bb
update exmaples change to using values refactor(git)!: improve CreateRef API with value types and exported struct format new updateref struct remove backwards compatibility create tag in git tags slfhg

rupokghosh force-pushed the rupok/change-pointer-params-to-values branch from 939e78a to 92a65bbCompare August 4, 2025 18:51

rupokghosh requested a review from alexandear August 4, 2025 18:52

gmlewis approved these changes Aug 4, 2025
View reviewed changes

gmlewis merged commit db8be8b into google:masterAug 4, 2025
5 of 7 checks passed

alexandear mentioned this pull request Aug 18, 2025
refactor!: Refactor GistsService to use value parameters #3680
Closed

gmlewis mentioned this pull request Sep 22, 2025
Bump version of go-github to v75.0.0 #3723
Merged

This was referenced Jun 23, 2026
refactor!: Pass GistsService required params by value #4320
Merged
refactor!: Pass release params by value and rename EditRelease to UpdateRelease#4329
Merged

This was referenced Jun 26, 2026
refactor!: Pass release-notes and asset params by value and rename EditReleaseAsset to UpdateReleaseAsset#4336
Merged
refactor!: Pass CreateJITConfigRequest by value and rename Generate*JITConfig to Create*JITConfig#4337
Merged

Navigation Menu

Uh oh!

refactor!: Change `GitService` methods to pass required params by-value instead of by-ref - #3654

refactor!: Change `GitService` methods to pass required params by-value instead of by-ref#3654
gmlewis merged 1 commit into
google:masterfrom
rupokghosh:rupok/change-pointer-params-to-values

rupokghosh commented Jul 27, 2025•
edited by gmlewis
Loading

Uh oh!

gmlewis commented Jul 27, 2025

Uh oh!

rupokghosh commented Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

codecovBot commented Jul 28, 2025•
edited
Loading

Uh oh!

Uh oh!

gmlewis left a comment

Uh oh!

alexandear commented Aug 4, 2025

Uh oh!

gmlewis commented Aug 4, 2025

Uh oh!

gmlewis commented Aug 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rupokghosh commented Aug 4, 2025

Uh oh!

gmlewis left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

rupokghosh commented Jul 27, 2025• edited by gmlewis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What problem are you solving?

Notes

Uh oh!

gmlewis commented Jul 27, 2025

Uh oh!

rupokghosh commented Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

alexandear commented Aug 4, 2025

Uh oh!

gmlewis commented Aug 4, 2025

Uh oh!

gmlewis commented Aug 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rupokghosh commented Aug 4, 2025

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rupokghosh commented Jul 27, 2025•
edited by gmlewis
Loading

codecovBot commented Jul 28, 2025•
edited
Loading