github

Documentation

Overview

Package github provides a library for downloading release assets from GitHub.

Index

• func Decompress(archiveStream io.ReadCloser, filename, findPattern, writeToBin string) (string, error)
• func DownloadStream(archiveStream io.ReadCloser, filename, findPattern, writeToBin string) (string, error)
• func GetAssetStream(client *gh.Client, ownerRepo []string, release *gh.RepositoryRelease, ...) (archiveStream io.ReadCloser, name string, err error)
• func GetLatestRelease(client *gh.Client, owner, repo string) (*gh.RepositoryRelease, error)
• func GetLatestTag(client *gh.Client, owner, repo, constraint string) (*version.Version, error)
• func GetReleaseVersion(client *gh.Client, owner, repo, tag string) (*gh.RepositoryRelease, error)
• func InvertTag(tag string) string
• func NewClient(input *NewClientInput) (*gh.Client, error)
• func ParseDomain(domain string) (apiEndpoint, uploadEndpoint string, subdomainIsolation bool)
• func RemoveVFromTag(tag string) string
• type NewClientInput

Functions

func Decompress

func Decompress(archiveStream io.ReadCloser, filename, findPattern, writeToBin string) (string, error)

func DownloadStream

func DownloadStream(archiveStream io.ReadCloser, filename, findPattern, writeToBin string) (string, error)

func GetAssetStream

func GetAssetStream(
	client *gh.Client,
	ownerRepo []string,
	release *gh.RepositoryRelease,
	pattern string,
) (archiveStream io.ReadCloser, name string, err error)

func GetLatestRelease

func GetLatestRelease(client *gh.Client, owner, repo string) (*gh.RepositoryRelease, error)

func GetLatestTag

func GetLatestTag(client *gh.Client, owner, repo, constraint string) (*version.Version, error)

func GetReleaseVersion

func GetReleaseVersion(client *gh.Client, owner, repo, tag string) (*gh.RepositoryRelease, error)

func InvertTag

func InvertTag(tag string) string

func NewClient

func NewClient(input *NewClientInput) (*gh.Client, error)

func ParseDomain

func ParseDomain(domain string) (
	apiEndpoint,
	uploadEndpoint string,
	subdomainIsolation bool,
)

func RemoveVFromTag

func RemoveVFromTag(tag string) string

Types

type NewClientInput

type NewClientInput struct {
	Endpoint string
	Token    string
}