github

Documentation

Index

• type ZIPDownloader
  • func (z *ZIPDownloader) DownloadToFile(url string) error
  • func (z *ZIPDownloader) UnzipToDir() error
• type ZIPReleaseGetter
  • func (z *ZIPReleaseGetter) GetLatestRelease() error
  • func (z *ZIPReleaseGetter) GetRelease(releaseTag string) error

Types

type ZIPDownloader

type ZIPDownloader struct {
	ZipFolderDest   string
	ZipName         string
	AssetFolderDest string

	RemoveAfterDownload bool
}

func (*ZIPDownloader) DownloadToFile

func (z *ZIPDownloader) DownloadToFile(url string) error

func (*ZIPDownloader) UnzipToDir

func (z *ZIPDownloader) UnzipToDir() error

type ZIPReleaseGetter

type ZIPReleaseGetter struct {
	// The name of the asset, i.e. "porter", "portersvr", "static"
	AssetName string

	// The host folder destination of the asset
	AssetFolderDest string

	// The host folder destination for the .zip file
	ZipFolderDest string

	// The name of the .zip file to download to
	ZipName string

	// The name of the Github entity whose repo is queried: i.e. "porter-dev"
	EntityID string

	// The name of the Github repo to get releases from
	RepoName string

	// If the asset is platform dependent
	IsPlatformDependent bool

	// The downloader/unzipper
	Downloader *ZIPDownloader
}

ZIPReleaseGetter retrieves a release from Github in ZIP format and downloads it to a directory on host

func (*ZIPReleaseGetter) GetLatestRelease

func (z *ZIPReleaseGetter) GetLatestRelease() error

GetLatestRelease downloads the latest .zip release from a given Github repository

func (*ZIPReleaseGetter) GetRelease

func (z *ZIPReleaseGetter) GetRelease(releaseTag string) error

GetRelease downloads a specific .zip release from a given Github repository