githubrepo

Documentation

Overview

Package githubrepo implements clients.RepoClient for GitHub.

Index

• func CreateGithubRepoClient(ctx context.Context, logger *zap.Logger) clients.RepoClient
• func MakeGithubRepo(input string) (clients.Repo, error)
• func NewLogger(logLevel zapcore.Level) (*zap.Logger, error)
• type Client
  • func (client *Client) Close() error
  • func (client *Client) GetDefaultBranch() (*clients.BranchRef, error)
  • func (client *Client) GetFileContent(filename string) ([]byte, error)
  • func (client *Client) InitRepo(inputRepo clients.Repo) error
  • func (client *Client) IsArchived() (bool, error)
  • func (client *Client) ListBranches() ([]*clients.BranchRef, error)
  • func (client *Client) ListCheckRunsForRef(ref string) ([]clients.CheckRun, error)
  • func (client *Client) ListCommits() ([]clients.Commit, error)
  • func (client *Client) ListContributors() ([]clients.Contributor, error)
  • func (client *Client) ListFiles(predicate func(string) (bool, error)) ([]string, error)
  • func (client *Client) ListMergedPRs() ([]clients.PullRequest, error)
  • func (client *Client) ListReleases() ([]clients.Release, error)
  • func (client *Client) ListStatuses(ref string) ([]clients.Status, error)
  • func (client *Client) ListSuccessfulWorkflowRuns(filename string) ([]clients.WorkflowRun, error)
  • func (client *Client) Search(request clients.SearchRequest) (clients.SearchResponse, error)
  • func (client *Client) URL() string

Functions

func CreateGithubRepoClient

func CreateGithubRepoClient(ctx context.Context, logger *zap.Logger) clients.RepoClient

CreateGithubRepoClient returns a Client which implements RepoClient interface.

func MakeGithubRepo

func MakeGithubRepo(input string) (clients.Repo, error)

MakeGithubRepo takes input of form "owner/repo" or "github.com/owner/repo" and returns an implementation of clients.Repo interface.

func NewLogger

func NewLogger(logLevel zapcore.Level) (*zap.Logger, error)

NewLogger creates an instance of *zap.Logger.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is GitHub-specific implementation of RepoClient.

func (*Client) Close

func (client *Client) Close() error

Close implements RepoClient.Close.

func (*Client) GetDefaultBranch

func (client *Client) GetDefaultBranch() (*clients.BranchRef, error)

GetDefaultBranch implements RepoClient.GetDefaultBranch.

func (*Client) GetFileContent

func (client *Client) GetFileContent(filename string) ([]byte, error)

GetFileContent implements RepoClient.GetFileContent.

func (*Client) InitRepo

func (client *Client) InitRepo(inputRepo clients.Repo) error

InitRepo sets up the GitHub repo in local storage for improving performance and GitHub token usage efficiency.

func (*Client) IsArchived

func (client *Client) IsArchived() (bool, error)

IsArchived implements RepoClient.IsArchived.

func (*Client) ListBranches

func (client *Client) ListBranches() ([]*clients.BranchRef, error)

ListBranches implements RepoClient.ListBranches.

func (*Client) ListCheckRunsForRef

func (client *Client) ListCheckRunsForRef(ref string) ([]clients.CheckRun, error)

ListCheckRunsForRef implements RepoClient.ListCheckRunsForRef.

func (*Client) ListCommits

func (client *Client) ListCommits() ([]clients.Commit, error)

ListCommits implements RepoClient.ListCommits.

func (*Client) ListContributors

func (client *Client) ListContributors() ([]clients.Contributor, error)

ListContributors implements RepoClient.ListContributors.

func (*Client) ListFiles

func (client *Client) ListFiles(predicate func(string) (bool, error)) ([]string, error)

ListFiles implements RepoClient.ListFiles.

func (*Client) ListMergedPRs

func (client *Client) ListMergedPRs() ([]clients.PullRequest, error)

ListMergedPRs implements RepoClient.ListMergedPRs.

func (*Client) ListReleases

func (client *Client) ListReleases() ([]clients.Release, error)

ListReleases implements RepoClient.ListReleases.

func (*Client) ListStatuses

func (client *Client) ListStatuses(ref string) ([]clients.Status, error)

ListStatuses implements RepoClient.ListStatuses.

func (*Client) ListSuccessfulWorkflowRuns

func (client *Client) ListSuccessfulWorkflowRuns(filename string) ([]clients.WorkflowRun, error)

ListSuccessfulWorkflowRuns implements RepoClient.WorkflowRunsByFilename.

func (*Client) Search

func (client *Client) Search(request clients.SearchRequest) (clients.SearchResponse, error)

Search implements RepoClient.Search.

func (*Client) URL

func (client *Client) URL() string

URL implements RepoClient.URL.