types

Documentation

Index

• type GithubAuthenticationProvider
• type GithubClientOptions
  • func NewOptions(appName string, appVersion string) *GithubClientOptions
  • func (o *GithubClientOptions) WithApp(appName string, appVersion string) *GithubClientOptions
  • func (o *GithubClientOptions) WithAuthenticationProvider(provider GithubAuthenticationProvider) *GithubClientOptions
  • func (o *GithubClientOptions) WithCustom(cfg func(client *github.Client)) *GithubClientOptions
  • func (o *GithubClientOptions) WithHTTPClient(cl *http.Client) *GithubClientOptions
• type ReleaseCandidate
• type VersioningStrategy

Types

type GithubAuthenticationProvider

type GithubAuthenticationProvider interface {
	GetToken(ctx context.Context) (string, bool, error)
}

GithubAuthenticationProvider defines how the gh client gets authentication material (if relevant).

type GithubClientOptions

type GithubClientOptions struct {
	HTTPClient          *http.Client
	UserAgent           string
	CustomConfigurators []func(*github.Client)
	Authentication      GithubAuthenticationProvider
	AuthTimeout         time.Duration
}

GithubClientOptions sets up how we communicate with github.

func NewOptions

func NewOptions(appName string, appVersion string) *GithubClientOptions

NewOptions creates a new github client for a given repo.

func (*GithubClientOptions) WithApp

func (o *GithubClientOptions) WithApp(appName string, appVersion string) *GithubClientOptions

WithApp sets the user agent of the GH client.

func (*GithubClientOptions) WithAuthenticationProvider

func (o *GithubClientOptions) WithAuthenticationProvider(provider GithubAuthenticationProvider) *GithubClientOptions

WithAuthenticationProvider sets the authentication provider for this client.

func (*GithubClientOptions) WithCustom

func (o *GithubClientOptions) WithCustom(cfg func(client *github.Client)) *GithubClientOptions

WithCustom allows for custom overrides of the GH client library.

func (*GithubClientOptions) WithHTTPClient

func (o *GithubClientOptions) WithHTTPClient(cl *http.Client) *GithubClientOptions

WithHTTPClient sets an override http client for GH API interactions.

type ReleaseCandidate

type ReleaseCandidate struct {
	ID   int64
	Name string
}

type VersioningStrategy

type VersioningStrategy interface {
	// IsAcceptable determines if the new version is a an accepted version (IE don't accept prerelease)
	IsAcceptable(version *semver.Version) bool
	// IsUpgrade determines if a new version is an upgrade from an old version
	IsUpgrade(oldV *semver.Version, newV *semver.Version) bool
}

VersioningStrategy defines if a version is an upgrade from a prior version.