github

Documentation

Index

• Constants
• Variables
• func New(clientKey, secret, callbackURL string, opts ...Opt) *githubProvider
• type Opt
  • func WithAllowedOrgs(orgs ...string) Opt
  • func WithEnterpriseURL(url string) Opt
  • func WithScopes(scopes ...string) Opt

Constants

const NoopEmail = ""

Variables

var (
	ErrNoVerifiedPrimaryEmail = errors.New("goth: no verified primary email found")
	ErrFailedFetchUser        = errors.New("goth: no failed to fetch user")
	ErrNotAllowedOrg          = errors.New("goth: user not in allowed org")
	ErrNoName                 = errors.New("goth: user has no display name set")
)

var DefaultScopes = []string{"user:email", "read:user"}

DefaultScopes holds the default scopes used for GitHub.

Functions

func New

func New(clientKey, secret, callbackURL string, opts ...Opt) *githubProvider

New creates a new GitHub provider.

Types

type Opt

type Opt func(*githubProvider)

Opt is a function that configures the GitHub provider.

func WithAllowedOrgs

func WithAllowedOrgs(orgs ...string) Opt

WithAllowedOrgs sets the allowed organizations for the GitHub provider.

func WithEnterpriseURL

func WithEnterpriseURL(url string) Opt

WithEnterpriseURL sets the enterprise URL for the GitHub provider.

func WithScopes

func WithScopes(scopes ...string) Opt

WithScopes sets the scopes for the GitHub provider.