context

Documentation

Index

• func ConfigDir() string
• func NewBlank() *blankContext
• func ParseDefaultConfig() (*configEntry, error)
• type Context
  • func New() Context
• 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)
  • func (r Remotes) Len() int
  • func (r Remotes) Less(i, j int) bool
  • func (r Remotes) Swap(i, j int)
• type ResolvedRemotes
  • func ResolveRemotesToRepos(remotes Remotes, client *api.Client, base string) (ResolvedRemotes, error)
  • func (r ResolvedRemotes) BaseRepo() (*api.Repository, error)
  • func (r ResolvedRemotes) HeadRepo() (*api.Repository, error)
  • func (r ResolvedRemotes) RemoteForRepo(repo ghrepo.Interface) (*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() (ghrepo.Interface, 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 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

func (Remotes) Len

func (r Remotes) Len() int

https://golang.org/pkg/sort/#Interface

func (Remotes) Less

func (r Remotes) Less(i, j int) bool

func (Remotes) Swap

func (r Remotes) Swap(i, j int)

type ResolvedRemotes

type ResolvedRemotes struct {
	BaseOverride ghrepo.Interface
	Remotes      Remotes
	Network      api.RepoNetworkResult
	// contains filtered or unexported fields
}

func ResolveRemotesToRepos

func ResolveRemotesToRepos(remotes Remotes, client *api.Client, base string) (ResolvedRemotes, error)

func (ResolvedRemotes) BaseRepo

func (r ResolvedRemotes) BaseRepo() (*api.Repository, error)

BaseRepo is the first found repository in the "upstream", "github", "origin" git remote order, resolved to the parent repo if the git remote points to a fork

func (ResolvedRemotes) HeadRepo

func (r ResolvedRemotes) HeadRepo() (*api.Repository, error)

HeadRepo is a fork of base repo (if any), or the first found repository that has push access

func (ResolvedRemotes) RemoteForRepo

func (r ResolvedRemotes) RemoteForRepo(repo ghrepo.Interface) (*Remote, error)

RemoteForRepo finds the git remote that points to a repository