github

Documentation

Overview

Description: Implements consistent ways to get Auth across platforms.

Package github includes helper functions for standardized ways of interacting with Github across machines.

Description: This file contains the options for the github client.

Index

• func GetToken() (cfg.SecretData, error)
• func NewClient(optFns ...Option) (*github.Client, error)
• type Option
  • func WithAllowUnauthenticated() Option
  • func WithLogger(log logrus.FieldLogger) Option
• type Options

Functions

func GetToken

func GetToken() (cfg.SecretData, error)

GetToken returns a github access token from the machine

func NewClient

func NewClient(optFns ...Option) (*github.Client, error)

NewClient returns a new Github client using credentials from GetToken().

Types

type Option

type Option func(*Options)

Option is a functional option for configuring a client

func WithAllowUnauthenticated

func WithAllowUnauthenticated() Option

WithAllowUnauthenticated allows the client to be created without a token.

func WithLogger

func WithLogger(log logrus.FieldLogger) Option

WithLogger provides a logger for the client

type Options

type Options struct {
	// AllowUnauthenticated allows the client to be created without
	// a token.
	AllowUnauthenticated bool

	// Logger is an optional logger to use for logging
	Logger logrus.FieldLogger
}

Options contains the options for a Github client