context

Documentation

Index

• func ConfigDir() string
• func NewBlank() *blankContext
• func ParseDefaultConfig() (*configEntry, error)
• type Context
  • func New() Context
• type GitHubRepository
  • func RepoFromURL(u *url.URL) (GitHubRepository, error)
• type Remote
  • func (r Remote) RepoName() string
  • func (r Remote) RepoOwner() string
• type Remotes
  • func (r Remotes) FindByName(names ...string) (*Remote, error)
  • func (r Remotes) FindByRepo(owner, name string) (*Remote, error)

Functions

func ConfigDir

func ConfigDir() string

func NewBlank

func NewBlank() *blankContext

NewBlank initializes a blank Context suitable for testing

func ParseDefaultConfig

func ParseDefaultConfig() (*configEntry, error)

ParseDefaultConfig reads the configuration file

Types

type Context

type Context interface {
	AuthToken() (string, error)
	SetAuthToken(string)
	AuthLogin() (string, error)
	Branch() (string, error)
	SetBranch(string)
	Remotes() (Remotes, error)
	BaseRepo() (GitHubRepository, error)
	SetBaseRepo(string)
}

Context represents the interface for querying information about the current environment

func New

func New() Context

New initializes a Context that reads from the filesystem

type GitHubRepository

type GitHubRepository interface {
	RepoOwner() string
	RepoName() string
}

GitHubRepository is anything that can be mapped to an OWNER/REPO pair

func RepoFromURL

func RepoFromURL(u *url.URL) (GitHubRepository, error)

RepoFromURL maps a URL to a GitHubRepository

type Remote

type Remote struct {
	*git.Remote
	Owner string
	Repo  string
}

Remote represents a git remote mapped to a GitHub repository

func (Remote) RepoName

func (r Remote) RepoName() string

RepoName is the name of the GitHub repository

func (Remote) RepoOwner

func (r Remote) RepoOwner() string

RepoOwner is the name of the GitHub account that owns the repo

type Remotes

type Remotes []*Remote

Remotes represents a set of git remotes

func (Remotes) FindByName

func (r Remotes) FindByName(names ...string) (*Remote, error)

FindByName returns the first Remote whose name matches the list

func (Remotes) FindByRepo

func (r Remotes) FindByRepo(owner, name string) (*Remote, error)

FindByRepo returns the first Remote that points to a specific GitHub repository