githubutil

Documentation

Index

• Variables
• func CheckBrewInstall(goos platformutil.Platform) (string, error)
• func CheckVersionExist(version, repository string) (*github.RepositoryRelease, error)
• func GetAssetsFromRelease(version, assets, repository string) (*github.ReleaseAsset, error)
• func GetFullyQualifiedImageName(version, image string, pre bool) (string, string, error)
• func GetGHClient() *github.Client
• func GetLatestVersion(repository string) (*github.RepositoryRelease, error)
• func GetListRelease(repository string) ([]*github.RepositoryRelease, error)
• func GetSHAFromVersion(version, repository string) (string, error)
• func GetSandboxImageSha(version string, pre bool) (string, string, error)
• func GetUpgradeMessage(latest string, goos platformutil.Platform) (string, error)

Variables

var FlytectlReleaseConfig = &updater.Updater{
	Provider: &provider.Github{
		RepositoryURL: flytectlRepository,
		ArchiveName:   getFlytectlAssetName(),
	},
	ExecutableName: flytectl,
	Version:        stdlibversion.Version,
}

FlytectlReleaseConfig represent the updater config for flytectl binary

Functions

func CheckBrewInstall

func CheckBrewInstall(goos platformutil.Platform) (string, error)

CheckBrewInstall returns the path of symlink if flytectl is installed from brew

func CheckVersionExist

func CheckVersionExist(version, repository string) (*github.RepositoryRelease, error)

CheckVersionExist returns the provided version release if version exist in repository

func GetAssetsFromRelease

func GetAssetsFromRelease(version, assets, repository string) (*github.ReleaseAsset, error)

GetAssetsFromRelease returns the asset from github release

func GetFullyQualifiedImageName

func GetFullyQualifiedImageName(version, image string, pre bool) (string, string, error)

GetFullyQualifiedImageName Returns the sandbox image, version and error if no version is specified then the Latest release of cr.flyte.org/flyteorg/flyte-sandbox:dind-{SHA} is used else cr.flyte.org/flyteorg/flyte-sandbox:dind-{SHA}, where sha is derived from the version. If pre release is true then use latest pre release of Flyte, In that case User don't need to pass version

func GetGHClient

func GetGHClient() *github.Client

GetGHClient will return github client

func GetLatestVersion

func GetLatestVersion(repository string) (*github.RepositoryRelease, error)

GetLatestVersion returns the latest non-prerelease version of provided repository, as described in https://docs.github.com/en/rest/reference/releases#get-the-latest-release

func GetListRelease

func GetListRelease(repository string) ([]*github.RepositoryRelease, error)

GetListRelease returns the list of release of provided repository

func GetSHAFromVersion

func GetSHAFromVersion(version, repository string) (string, error)

GetSHAFromVersion returns sha commit hash against a release

func GetSandboxImageSha

func GetSandboxImageSha(version string, pre bool) (string, string, error)

GetSandboxImageSha returns the sha as per input

func GetUpgradeMessage

func GetUpgradeMessage(latest string, goos platformutil.Platform) (string, error)

GetUpgradeMessage return the upgrade message