1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/pkg/github/commit.go
Christopher Fenner 8e0209db74
feat(GitHub): fetch commit statistics (#3381)
* fetch GH statistics

* move GH and Sonar integration tests to own files

* fix imports

* add integration test case

* add result type

* Apply suggestions from code review
2022-01-24 13:43:07 +01:00

44 lines
1.3 KiB
Go

package github
import (
"github.com/pkg/errors"
)
// FetchCommitOptions to configure the lookup
type FetchCommitOptions struct {
APIURL string `json:"apiUrl,omitempty"`
Owner string `json:"owner,omitempty"`
Repository string `json:"repository,omitempty"`
Token string `json:"token,omitempty"`
SHA string `json:"sha,omitempty"`
}
// FetchCommitResult to handle the lookup result
type FetchCommitResult struct {
Files int
Total int
Additions int
Deletions int
}
// https://docs.github.com/en/rest/reference/commits#get-a-commit
// FetchCommitStatistics looks up the statistics for a certain commit SHA.
func FetchCommitStatistics(options *FetchCommitOptions) (FetchCommitResult, error) {
// create GitHub client
ctx, client, err := NewClient(options.Token, options.APIURL, "")
if err != nil {
return FetchCommitResult{}, errors.Wrap(err, "failed to get GitHub client")
}
// fetch commit by SAH
result, _, err := client.Repositories.GetCommit(ctx, options.Owner, options.Repository, options.SHA)
if err != nil {
return FetchCommitResult{}, errors.Wrap(err, "failed to get GitHub commit")
}
return FetchCommitResult{
Files: len(result.Files),
Total: result.Stats.GetTotal(),
Additions: result.Stats.GetAdditions(),
Deletions: result.Stats.GetDeletions(),
}, nil
}