sap-jenkins-library/pkg/github/commit.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"`
	TrustedCerts []string `json:"trustedCerts,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, "", options.TrustedCerts)
	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
}