refactor!: Change required params from pointers to values

[rupokghosh]

BREAKING CHANGE: GitService endpoints 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:

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

[gmlewis]

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

[rupokghosh]

done ✔️ @gmlewis

[codecov]

Codecov Report

❌ Patch coverage is 62.50000% with 3 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (master@6dda213). Learn more about missing BASE report.
⚠️ Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
example/commitpr/main.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #3654   +/-   ##
=========================================
  Coverage          ?   91.24%           
=========================================
  Files             ?      184           
  Lines             ?    16299           
  Branches          ?        0           
=========================================
  Hits              ?    14872           
  Misses            ?     1245           
  Partials          ?      182           

☔ 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.

[alexandear]

Since we are breaking compatibility here, I propose refactoring:

// CreateRef represents the payload for creating a reference.
type CreateRef struct {
	Ref string `json:"ref"`
	SHA string `json:"sha"`
}

func (s *GitService) CreateRef(ctx context.Context, owner string, repo string, ref CreateRef) (*Reference, *Response, error) {
	u := fmt.Sprintf("repos/%v/%v/git/refs", owner, repo)
	req, err := s.client.NewRequest("POST", u, ref)
	if err != nil {
		return nil, nil, err
	}
	// ...

What do you think?

[gmlewis]

Sounds good to me. And while you are here, this should be owner, repo string instead of owner string, repo string.

[alexandear]

And while you are here, this should be owner, repo string instead of owner string, repo string.

Fixed in a separate PR #3655

[rupokghosh]

can this change come in a separate PR or should I ship this in this PR? I see that this would require some heavy changes in test cases and I am thinking it might be out of scope of this PR? what do you guys think?

[gmlewis]

Since this is already a disruptive API-breaking PR, I suggest we go ahead and address it here within this PR instead of breaking the API twice.