githubclient

Documentation

Overview

Package githubclient is a wrapper around the GitHub App for common operations.

Index

• type Client
  • func New(ctx context.Context, c *Config) (*Client, error)
  • func (c *Client) App() *githubauth.App
  • func (c *Client) GitHubClientFromTokenSource(ctx context.Context, ts oauth2.TokenSource) (*github.Client, error)
  • func (c *Client) ListDeliveries(ctx context.Context, opts *github.ListCursorOptions) ([]*github.HookDelivery, *github.Response, error)
  • func (c *Client) RedeliverEvent(ctx context.Context, deliveryID int64) error
• type Config
  • func (c *Config) ToFlags(set *cli.FlagSet)
  • func (c *Config) Validate(ctx context.Context) error

Types

type Client

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

Client is a wrapper around a GitHub HTTP client and an authenticated GitHub App.

func New

func New(ctx context.Context, c *Config) (*Client, error)

New creates a new Client from the given config.

func (*Client) App

func (c *Client) App() *githubauth.App

App returns the underlying githubauth.App.

func (*Client) GitHubClientFromTokenSource

func (c *Client) GitHubClientFromTokenSource(ctx context.Context, ts oauth2.TokenSource) (*github.Client, error)

GitHubClientFromTokenSource creates a new GitHub client from the given token source. It inherits any configuration from the GitHub config (like enterprise URL).

func (*Client) ListDeliveries

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

ListDeliveries lists a paginated result of event deliveries.

func (*Client) RedeliverEvent

func (c *Client) RedeliverEvent(ctx context.Context, deliveryID int64) error

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

type Config

type Config struct {
	// GitHubEnterpriseServerURL tis he GitHub Enterprise Server instance URL, in
	// the format "https://[hostname]".
	GitHubEnterpriseServerURL string

	// GitHubAppID is the GitHub App ID. This comes from the GitHub API.
	GitHubAppID string

	// GitHubPrivateKey is the GitHub App private key.
	GitHubPrivateKey string

	// GitHubPrivateKeyKMSKeyID is the KMS key ID to use for the GitHub App
	// private key. This is mutually-exclusive with [GitHubPrivateKey].
	GitHubPrivateKeyKMSKeyID string
}

Config represents the shared GitHub App configuration.

func (*Config) ToFlags

func (c *Config) ToFlags(set *cli.FlagSet)

ToFlags registers the GitHub flags.

func (*Config) Validate

func (c *Config) Validate(ctx context.Context) error

Validate does sanity checking on the configuration.