context

package

v2.49.2 Latest Latest Go to latest Published: May 13, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cli/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

TODO: rename this package to avoid clash with stdlib

Index ¶

type Remote
type Remotes
- func TranslateRemotes(gitRemotes git.RemoteSet, translator Translator) (remotes Remotes)
type ResolvedRemotes
- func ResolveRemotesToRepos(remotes Remotes, client *api.Client, base string) (*ResolvedRemotes, error)
type Translator

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.ir/pkg/sort/#Interface

func (Remotes) Less ¶

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

func (Remotes) ResolvedRemote ¶ added in v2.21.0

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 ¶ added in v2.21.0

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 ¶ added in v2.12.1

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL