github

Documentation

Index

• type RepositoryClient
  • func NewRepositoryClient(ctx context.Context, accessToken, owner, repo string, waitForQuotaReset bool) *RepositoryClient
  • func (r *RepositoryClient) DownloadArtifacts(ctx context.Context, artifactList []*github.Artifact, dir, namePattern string, ...) ([]string, error)
  • func (r *RepositoryClient) ListAllArtifacts(ctx context.Context) ([]*github.Artifact, error)
  • func (r *RepositoryClient) ListCommitsFromPR(ctx context.Context, pullNum int) ([]string, error)
  • func (r *RepositoryClient) ListPRComments(ctx context.Context, pullNum int) ([]*github.IssueComment, error)
  • func (r *RepositoryClient) PostPRComment(ctx context.Context, pullNum int, data *string) error

Types

type RepositoryClient

type RepositoryClient struct {
	*github.Client
	Owner             string
	Repo              string
	WaitForQuotaReset bool
}

func NewRepositoryClient

func NewRepositoryClient(ctx context.Context, accessToken, owner, repo string, waitForQuotaReset bool) *RepositoryClient

func (*RepositoryClient) DownloadArtifacts

func (r *RepositoryClient) DownloadArtifacts(ctx context.Context, artifactList []*github.Artifact, dir,
	namePattern string, after, before *time.Time) ([]string, error)

DownloadArtifacts tries to download artifacts from a artifact list to a directory based on name and time filtering. The client is required to have authentication. The function returns a list of successfully downloaded artifacts and error. Github API related errors are aggrgated and do not stop its following operations due to possible throttling.

func (*RepositoryClient) ListAllArtifacts

func (r *RepositoryClient) ListAllArtifacts(ctx context.Context) ([]*github.Artifact, error)

func (*RepositoryClient) ListCommitsFromPR

func (r *RepositoryClient) ListCommitsFromPR(ctx context.Context, pullNum int) ([]string, error)

func (*RepositoryClient) ListPRComments

func (r *RepositoryClient) ListPRComments(ctx context.Context, pullNum int) ([]*github.IssueComment, error)

func (*RepositoryClient) PostPRComment

func (r *RepositoryClient) PostPRComment(ctx context.Context, pullNum int, data *string) error