github

Documentation

Overview

Package github provides methods for creating a Github client for the purposes of interacting with the API. Provides support for retrieving authentication tokens from the following sources:

- Environment variables ($GITHUB_TOKEN) - Github CLI

Index

• func New() (*github.Client, error)
• func Token() (string, error)
• type ErrNoToken
  • func (e ErrNoToken) Error() string
  • func (e ErrNoToken) Unwrap() []error

Functions

func New

func New() (*github.Client, error)

New returns a new github.Client using credentials from one of the configured credential providers. If no token is found, an unauthenticated client is returned.

func Token

func Token() (string, error)

Token returns a valid token from one of the configured credential providers. If no token is found, ErrNoToken is returned.

Types

type ErrNoToken

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

ErrNoToken is returned when no token is found in the configured credential providers.

func (ErrNoToken) Error

func (e ErrNoToken) Error() string

Error returns the error message for ErrNoToken.

func (ErrNoToken) Unwrap

func (e ErrNoToken) Unwrap() []error

Unwrap returns the errors that caused the ErrNoToken error.