context

Documentation

Overview

TODO: rename this package to avoid clash with stdlib

Index

• type Remote
  • func (r Remote) RepoHost() string
  • func (r Remote) RepoName() string
  • func (r Remote) RepoOwner() string
• type Remotes
  • func TranslateRemotes(gitRemotes git.RemoteSet, translator Translator) (remotes Remotes)
  • func (r Remotes) FilterByHosts(hosts []string) 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) ResolvedRemote() (*Remote, error)
  • func (r Remotes) Swap(i, j int)
• type ResolvedRemotes
  • func ResolveRemotesToRepos(remotes Remotes, client *api.Client, base string) (*ResolvedRemotes, error)
  • func (r *ResolvedRemotes) BaseRepo(io *iostreams.IOStreams) (ghrepo.Interface, error)
  • func (r *ResolvedRemotes) HeadRepos() ([]*api.Repository, error)
  • func (r *ResolvedRemotes) NetworkRepos(remotesForLookup int) ([]*api.Repository, error)
  • func (r *ResolvedRemotes) RemoteForRepo(repo ghrepo.Interface) (*Remote, error)
• type Translator

Types

type Remote

type Remote struct {
	*git.Remote
	Repo ghrepo.Interface
}

Remote represents a git remote mapped to a GitHub repository

func (Remote) RepoHost

func (r Remote) RepoHost() string

RepoHost is the GitHub hostname that the remote points to

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 TranslateRemotes

func TranslateRemotes(gitRemotes git.RemoteSet, translator Translator) (remotes Remotes)

func (Remotes) FilterByHosts

func (r Remotes) FilterByHosts(hosts []string) Remotes

Filter remotes by given hostnames, maintains original order

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) ResolvedRemote

func (r Remotes) ResolvedRemote() (*Remote, error)

func (Remotes) Swap

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

type ResolvedRemotes

type ResolvedRemotes struct {
	// 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(io *iostreams.IOStreams) (ghrepo.Interface, error)

func (*ResolvedRemotes) HeadRepos

func (r *ResolvedRemotes) HeadRepos() ([]*api.Repository, error)

func (*ResolvedRemotes) NetworkRepos

func (r *ResolvedRemotes) NetworkRepos(remotesForLookup int) ([]*api.Repository, error)

NetworkRepos fetches info about remotes for the network of repos. Pass a value of 0 to fetch info on all remotes.

func (*ResolvedRemotes) RemoteForRepo

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

RemoteForRepo finds the git remote that points to a repository

type Translator

type Translator interface {
	Translate(*url.URL) *url.URL
}