gh

Documentation

Index

• func NewClient(cfg *ClientConfig, log config.Logger) (*github.Client, error)
• type AppConfig
• type AuthConfig
• type ClientConfig
  • func (c *ClientConfig) Validate() error
• type LogRateLimitHeaders
  • func (l LogRateLimitHeaders) RoundTrip(request *http.Request) (*http.Response, error)

Functions

func NewClient

func NewClient(cfg *ClientConfig, log config.Logger) (*github.Client, error)

Types

type AppConfig

type AppConfig struct {
	// GitHub App ID for authentication.
	ID int64 `yaml:"id"`

	// GitHub App Installation ID.
	InstallationID int64 `yaml:"installationId"`

	// GitHub App private key in PEM format.
	PrivateKey string `yaml:"privateKey"`
}

AppConfig represents the GitHub App configuration.

type AuthConfig

type AuthConfig struct {
	// The GitHub access token.
	// Instruction for creating a token can be found here: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token.
	AccessToken string `yaml:"accessToken"`

	// AppConfig represents the GitHub App configuration.
	// This replaces the AccessToken
	App AppConfig `yaml:"app"`
}

AuthConfig represents the authentication configuration.

type ClientConfig

type ClientConfig struct {
	// Auth allows you to set either PAT or APP credentials.
	// If none provided then watch functionality could not work properly, e.g. you can reach the API calls quota or if you are setting GitHub Enterprise base URL then an unauthorized error can occur.
	Auth AuthConfig `yaml:"auth"`

	// The GitHub base URL for API requests. Defaults to the public GitHub API, but can be set to a domain endpoint to use with GitHub Enterprise.
	// Default: https://api.github.com/
	BaseURL string `yaml:"baseUrl"`

	// The GitHub upload URL for uploading files. It is taken into account only when the BaseURL is also set. If only the BaseURL is provided then this parameter defaults to the BaseURL value.
	// Default: https://uploads.github.com/
	UploadURL string `yaml:"uploadUrl"`
}

func (*ClientConfig) Validate

func (c *ClientConfig) Validate() error

Validate validates if provided client options are valid.

type LogRateLimitHeaders

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

func (LogRateLimitHeaders) RoundTrip

func (l LogRateLimitHeaders) RoundTrip(request *http.Request) (*http.Response, error)