Add ListOptions to GetCommit and CompareCommits to support pagination

[Saaarah]

No description provided.

[gmlewis]

Thanks, @Saaarah.

Please make sure to run unit tests before submitting PRs.
You will need to modify the unit tests since the API has changed with this PR.

Please check out surrounding tests to see how pagination is also tested. Thanks.

[Saaarah]

Thanks, @Saaarah.

Please make sure to run unit tests before submitting PRs.
You will need to modify the unit tests since the API has changed with this PR.

Please check out surrounding tests to see how pagination is also tested. Thanks.

Hi Glenn, thanks for reviewing my pull request and I've added the new parameters in the two API's unit tests. Thanks again!

[gmlewis]

Hi @Saaarah - it looks like there are some calls to these APIs in the examples, if you could please take a look and fix them.

Here is the error:

Run go vet ./...
# github.com/google/go-github/v37/example/commitpr
vet: example/commitpr/main.go:128:97: too few arguments in call to client.Repositories.GetCommit
Error: Process completed with exit code 2.

[Saaarah]

Hi @Saaarah - it looks like there are some calls to these APIs in the examples, if you could please take a look and fix them.

Here is the error:

Run go vet ./...
# github.com/google/go-github/v37/example/commitpr
vet: example/commitpr/main.go:128:97: too few arguments in call to client.Repositories.GetCommit
Error: Process completed with exit code 2.

Hi Glenn, I've fixed the example. Sorry for not updating all affected code, it'll be nice to have a small section in readme.md to ask contributors to run all necessary tests prior to creating pull request, which will be really helpful for first timer contributors.

[gmlewis]

it'll be nice to have a small section in readme.md to ask contributors to run all necessary tests prior to creating pull request, which will be really helpful for first timer contributors.

This is already covered in our CONTRIBUTING.md doc:

  5. Please run:
     * `go generate github.com/google/go-github/...`
     * `go test github.com/google/go-github/...`
     * `go vet github.com/google/go-github/...`

[gmlewis]

It now looks like gofmt needs to be run on the example code:

Run diff -u <(echo -n) <(gofmt -d -s .)
--- /dev/fd/63	2021-07-12 15:58:15.735418376 +0000
+++ /dev/fd/62	2021-07-12 15:58:15.735418376 +0000
@@ -0,0 +1,12 @@
+diff -u example/commitpr/main.go.orig example/commitpr/main.go
+--- example/commitpr/main.go.orig	2021-07-12 15:58:16.035434090 +0000
++++ example/commitpr/main.go	2021-07-12 15:58:16.035434090 +0000
+@@ -127,7 +127,7 @@
+ 	// Get the parent commit to attach the commit to.
+ 	opt := &github.ListOptions{
+ 		PerPage: 10,
+-		Page: 1,
++		Page:    1,
+ 	}
+ 	parent, _, err := client.Repositories.GetCommit(ctx, *sourceOwner, *sourceRepo, *ref.Object.SHA, opt)
+ 	if err != nil {
Error: Process completed with exit code 1.

[Saaarah]

it'll be nice to have a small section in readme.md to ask contributors to run all necessary tests prior to creating pull request, which will be really helpful for first timer contributors.

This is already covered in our CONTRIBUTING.md doc:

  5. Please run:
     * `go generate github.com/google/go-github/...`
     * `go test github.com/google/go-github/...`
     * `go vet github.com/google/go-github/...`

Ah thanks for pointing out! I've formatted the file and run all the commands listed above. Thanks Glenn!

[codecov]

Codecov Report

Merging #1960 (3d883f7) into master (cda3c0f) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1960   +/-   ##
=======================================
  Coverage   97.84%   97.84%           
=======================================
  Files         105      105           
  Lines        6809     6815    +6     
=======================================
+ Hits         6662     6668    +6     
  Misses         80       80           
  Partials       67       67           

Impacted Files	Coverage Δ
github/repos_commits.go	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cda3c0f...3d883f7. Read the comment docs.

[gmlewis]

Thank you, @Saaarah !
LGTM.

Awaiting second LGTM before merging.

[Parker77]

LGTM.