githubrepo

Documentation

Overview

Package githubrepo implements clients.RepoClient for GitHub.

Index

• func CreateGithubRepoClient(ctx context.Context, logger *log.Logger) clients.RepoClient
• func CreateGithubRepoClientWithTransport(ctx context.Context, rt http.RoundTripper) clients.RepoClient
• func CreateOssFuzzRepoClient(ctx context.Context, logger *log.Logger) (clients.RepoClient, error)
• func MakeGithubRepo(input string) (clients.Repo, error)
• type Client
  • func (client *Client) Close() error
  • func (client *Client) GetBranch(branch string) (*clients.BranchRef, error)
  • func (client *Client) GetCreatedAt() (time.Time, error)
  • func (client *Client) GetDefaultBranch() (*clients.BranchRef, error)
  • func (client *Client) GetDefaultBranchName() (string, error)
  • func (client *Client) GetFileReader(filename string) (io.ReadCloser, error)
  • func (client *Client) GetOrgRepoClient(ctx context.Context) (clients.RepoClient, error)
  • func (client *Client) InitRepo(inputRepo clients.Repo, commitSHA string, commitDepth int) error
  • func (client *Client) IsArchived() (bool, error)
  • func (client *Client) ListCheckRunsForRef(ref string) ([]clients.CheckRun, error)
  • func (client *Client) ListCommits() ([]clients.Commit, error)
  • func (client *Client) ListContributors() ([]clients.User, error)
  • func (client *Client) ListFiles(predicate func(string) (bool, error)) ([]string, error)
  • func (client *Client) ListIssues() ([]clients.Issue, error)
  • func (client *Client) ListLicenses() ([]clients.License, error)
  • func (client *Client) ListProgrammingLanguages() ([]clients.Language, 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) ListWebhooks() ([]clients.Webhook, error)
  • func (client *Client) LocalPath() (string, error)
  • func (client *Client) Search(request clients.SearchRequest) (clients.SearchResponse, error)
  • func (client *Client) SearchCommits(request clients.SearchCommitsOptions) ([]clients.Commit, error)
  • func (client *Client) URI() string
• type Repo
  • func (r *Repo) AppendMetadata(metadata ...string)
  • func (r *Repo) Host() string
  • func (r *Repo) IsValid() error
  • func (r *Repo) Metadata() []string
  • func (r *Repo) Path() string
  • func (r *Repo) String() string
  • func (r *Repo) URI() string

Functions

func CreateGithubRepoClient

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

CreateGithubRepoClient returns a Client which implements RepoClient interface.

func CreateGithubRepoClientWithTransport

func CreateGithubRepoClientWithTransport(ctx context.Context, rt http.RoundTripper) clients.RepoClient

CreateGithubRepoClientWithTransport returns a Client which implements RepoClient interface.

func CreateOssFuzzRepoClient

func CreateOssFuzzRepoClient(ctx context.Context, logger *log.Logger) (clients.RepoClient, error)

CreateOssFuzzRepoClient returns a RepoClient implementation initialized to `google/oss-fuzz` GitHub repository.

Deprecated: Searching the github.com/google/oss-fuzz repo for projects is flawed. Use a constructor from clients/ossfuzz instead. https://github.com/ossf/scorecard/issues/2670

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.

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) GetBranch

func (client *Client) GetBranch(branch string) (*clients.BranchRef, error)

GetBranch implements RepoClient.GetBranch.

func (*Client) GetCreatedAt

func (client *Client) GetCreatedAt() (time.Time, error)

GetCreatedAt is a getter for repo.CreatedAt.

func (*Client) GetDefaultBranch

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

GetDefaultBranch implements RepoClient.GetDefaultBranch.

func (*Client) GetDefaultBranchName

func (client *Client) GetDefaultBranchName() (string, error)

GetDefaultBranchName implements RepoClient.GetDefaultBranchName.

func (*Client) GetFileReader

func (client *Client) GetFileReader(filename string) (io.ReadCloser, error)

GetFileReader implements RepoClient.GetFileReader.

func (*Client) GetOrgRepoClient

func (client *Client) GetOrgRepoClient(ctx context.Context) (clients.RepoClient, error)

func (*Client) InitRepo

func (client *Client) InitRepo(inputRepo clients.Repo, commitSHA string, commitDepth int) 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) 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.User, 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) ListIssues

func (client *Client) ListIssues() ([]clients.Issue, error)

ListIssues implements RepoClient.ListIssues.

func (*Client) ListLicenses

func (client *Client) ListLicenses() ([]clients.License, error)

ListLicenses implements RepoClient.ListLicenses.

func (*Client) ListProgrammingLanguages

func (client *Client) ListProgrammingLanguages() ([]clients.Language, error)

ListProgrammingLanguages implements RepoClient.ListProgrammingLanguages.

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) ListWebhooks

func (client *Client) ListWebhooks() ([]clients.Webhook, error)

ListWebhooks implements RepoClient.ListWebhooks.

func (*Client) LocalPath

func (client *Client) LocalPath() (string, error)

LocalPath implements RepoClient.LocalPath.

func (*Client) Search

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

Search implements RepoClient.Search.

func (*Client) SearchCommits

func (client *Client) SearchCommits(request clients.SearchCommitsOptions) ([]clients.Commit, error)

SearchCommits implements RepoClient.SearchCommits.

func (*Client) URI

func (client *Client) URI() string

URI implements RepoClient.URI.

type Repo

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

func (*Repo) AppendMetadata

func (r *Repo) AppendMetadata(metadata ...string)

func (*Repo) Host

func (r *Repo) Host() string

func (*Repo) IsValid

func (r *Repo) IsValid() error

IsValid implements Repo.IsValid.

func (*Repo) Metadata

func (r *Repo) Metadata() []string

Metadata implements Repo.Metadata.

func (*Repo) Path

func (r *Repo) Path() string

Path() implements RepoClient.Path.

func (*Repo) String

func (r *Repo) String() string

String implements Repo.String.

func (*Repo) URI

func (r *Repo) URI() string

URI implements Repo.URI().