github

Documentation

Index

• func New(opts Opts) (remote.Remote, error)
• type Opts

Functions

func New

func New(opts Opts) (remote.Remote, error)

New returns a Remote implementation that integrates with a GitHub Cloud or GitHub Enterprise version control hosting provider.

Types

type Opts

type Opts struct {
	URL         string   // GitHub server url.
	Context     string   // Context to display in status check
	Client      string   // GitHub oauth client id.
	Secret      string   // GitHub oauth client secret.
	Scopes      []string // GitHub oauth scopes
	Username    string   // Optional machine account username.
	Password    string   // Optional machine account password.
	PrivateMode bool     // GitHub is running in private mode.
	SkipVerify  bool     // Skip ssl verification.
	MergeRef    bool     // Clone pull requests using the merge ref.
}

Opts defines configuration options.