ghrepo

Documentation

Overview

package ghrepo is a copy of https://github.com/cli/cli/tree/trunk/internal/ghrepo

Index

• func FormatRemoteURL(repo Interface, protocol string) string
• func FullName(r Interface) string
• func GenerateRepoURL(repo Interface, p string, args ...interface{}) string
• func IsSame(a, b Interface) bool
• type Interface
  • func FromFullName(nwo string) (Interface, error)
  • func FromFullNameWithHost(nwo, fallbackHost string) (Interface, error)
  • func FromURL(u *url.URL) (Interface, error)
  • func New(owner, repo string) Interface
  • func NewWithHost(owner, repo, hostname string) Interface

Functions

func FormatRemoteURL

func FormatRemoteURL(repo Interface, protocol string) string

TODO there is a parallel implementation for non-isolated commands

func FullName

func FullName(r Interface) string

FullName serializes a GitHub repository into an "OWNER/REPO" string

func GenerateRepoURL

func GenerateRepoURL(repo Interface, p string, args ...interface{}) string

func IsSame

func IsSame(a, b Interface) bool

IsSame compares two GitHub repositories

Types

type Interface

type Interface interface {
	RepoName() string
	RepoOwner() string
	RepoHost() string
}

Interface describes an object that represents a GitHub repository

func FromFullName

func FromFullName(nwo string) (Interface, error)

FromFullName extracts the GitHub repository information from the following formats: "OWNER/REPO", "HOST/OWNER/REPO", and a full URL.

func FromFullNameWithHost

func FromFullNameWithHost(nwo, fallbackHost string) (Interface, error)

FromFullNameWithHost is like FromFullName that defaults to a specific host for values that don't explicitly include a hostname.

func FromURL

func FromURL(u *url.URL) (Interface, error)

FromURL extracts the GitHub repository information from a git remote URL

func New

func New(owner, repo string) Interface

New instantiates a GitHub repository from owner and name arguments

func NewWithHost

func NewWithHost(owner, repo, hostname string) Interface

NewWithHost is like New with an explicit host name