ghrepo

package

v2.49.2 Latest Latest Go to latest Published: May 13, 2024 License: MIT Imports: 6 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

This section is empty.

This section is empty.

func FormatRemoteURL(repo Interface, protocol string) string

func FullName(r Interface) string

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

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

func IsSame(a, b Interface) bool

IsSame compares two GitHub repositories

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

Interface describes an object that represents a GitHub repository

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(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(u *url.URL) (Interface, error)

FromURL extracts the GitHub repository information from a git remote URL

func New(owner, repo string) Interface

New instantiates a GitHub repository from owner and name arguments

func NewWithHost(owner, repo, hostname string) Interface

NewWithHost is like New with an explicit host name