githubclient

Documentation

Index

• func NewGitHubApp(ctx context.Context, enterpriseURL, appID, rsaPrivateKeyPEM string) (*githubauth.App, error)
• func NewGitHubClient(ctx context.Context, ts oauth2.TokenSource, enterpriseURL string) (*github.Client, error)
• type GitHub
  • func New(ctx context.Context, appID, rsaPrivateKeyPEM string) (*GitHub, error)
  • func NewGitHubEnterpriseClient(ctx context.Context, enterpriseURL, appID, rsaPrivateKeyPEM string) (*GitHub, error)
  • func (gh *GitHub) ListDeliveries(ctx context.Context, opts *github.ListCursorOptions) ([]*github.HookDelivery, *github.Response, error)
  • func (gh *GitHub) RedeliverEvent(ctx context.Context, deliveryID int64) error

Functions

func NewGitHubApp

func NewGitHubApp(ctx context.Context, enterpriseURL, appID, rsaPrivateKeyPEM string) (*githubauth.App, error)

func NewGitHubClient

func NewGitHubClient(ctx context.Context, ts oauth2.TokenSource, enterpriseURL string) (*github.Client, error)

Types

type GitHub

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

func New

func New(ctx context.Context, appID, rsaPrivateKeyPEM string) (*GitHub, error)

New creates a new instance of a GitHub client.

func NewGitHubEnterpriseClient

func NewGitHubEnterpriseClient(ctx context.Context, enterpriseURL, appID, rsaPrivateKeyPEM string) (*GitHub, error)

NewGitHubEnterpriseClient creates a new instance of a GitHub client (for enterprise if enterpriseURL is non-empty).

func (*GitHub) ListDeliveries

func (gh *GitHub) ListDeliveries(ctx context.Context, opts *github.ListCursorOptions) ([]*github.HookDelivery, *github.Response, error)

ListDeliveries lists a paginated result of event deliveries.

func (*GitHub) RedeliverEvent

func (gh *GitHub) RedeliverEvent(ctx context.Context, deliveryID int64) error

RedeliverEvent redelivers a failed event which will be picked up by the webhook service.