versionstream

package
v3.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 19, 2024 License: Apache-2.0 Imports: 13 Imported by: 19

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Kinds all the version kinds
	Kinds = []VersionKind{
		KindChart,
		KindPackage,
		KindDocker,
		KindGit,
	}

	// KindStrings all the kinds as strings for validating CLI arguments
	KindStrings = []string{
		string(KindChart),
		string(KindPackage),
		string(KindDocker),
		string(KindGit),
	}
)

Functions

func ConvertToVersion added in v3.0.109 

func ConvertToVersion(text string) string

ConvertToVersion extracts a semantic version from the specified string. If no semantic version is contained in the specified string the string is returned unmodified.

func GitURLToName 

func GitURLToName(name string) string

GitURLToName lets trim any URL scheme and trailing .git or / from a git URL

func LoadStableVersionNumber 

func LoadStableVersionNumber(wrkDir string, kind VersionKind, name string, warnOnMissing bool) (string, error)

LoadStableVersionNumber loads just the stable version number for the given kind and name

func NameFromPath 

func NameFromPath(basepath string, path string) (string, error)

NameFromPath converts a path into a name for use with stable versions

func ResolveDockerImage 

func ResolveDockerImage(versionsDir, image string) (string, error)

ResolveDockerImage resolves the version of the specified image against the version stream defined in versionsDir. If there is a version defined for the image in the version stream 'image:<version>' is returned, otherwise the passed image name is returned as is.

func SaveQuickStarts 

func SaveQuickStarts(dir string, qs *QuickStarts) error

SaveQuickStarts saves the modified quickstarts in the version stream dir

func SaveStableVersion 

func SaveStableVersion(wrkDir string, kind VersionKind, name string, stableVersion *StableVersion) error

SaveStableVersion saves the version file

func SaveStableVersionFile 

func SaveStableVersionFile(path string, stableVersion *StableVersion) error

SaveStableVersionFile saves the stabe version to the given file name

func UpdateStableVersion 

func UpdateStableVersion(dir string, kindStr string, name string, version string) ([]string, error)

UpdateStableVersion applies an update to the stable version file in dir/kindStr/name.yml, updating to version

func UpdateStableVersionFiles 

func UpdateStableVersionFiles(globPattern string, version string, excludeFiles ...string) ([]string, error)

UpdateStableVersionFiles applies an update to the stable version files matched by globPattern, updating to version

Types

type Callback 

type Callback func(kind VersionKind, name string, version *StableVersion) (bool, error)

Callback a callback function for processing version information. Return true to continue processing or false to terminate the loop

type QuickStart 

type QuickStart struct {
	ID             string   `json:"id,omitempty"`
	Owner          string   `json:"owner,omitempty"`
	Name           string   `json:"name,omitempty"`
	Version        string   `json:"version,omitempty"`
	Language       string   `json:"language,omitempty"`
	Framework      string   `json:"framework,omitempty"`
	Tags           []string `json:"tags,omitempty"`
	DownloadZipURL string   `json:"downloadZipURL,omitempty"`
}

QuickStart the configuration of a quickstart in the version stream

type QuickStarts 

type QuickStarts struct {
	QuickStarts  []*QuickStart `json:"quickstarts"`
	DefaultOwner string        `json:"defaultOwner"`
}

QuickStarts the configuration of a the quickstarts in the version stream

func GetQuickStarts 

func GetQuickStarts(dir string) (*QuickStarts, error)

GetQuickStarts loads the quickstarts from the version stream

func (*QuickStarts) DefaultMissingValues 

func (qs *QuickStarts) DefaultMissingValues()

DefaultMissingValues defaults any missing values such as ID which is a combination of owner and name

func (*QuickStarts) Sort 

func (qs *QuickStarts) Sort()

Sort sorts the quickstarts into name order

type RepositoryPrefixes 

type RepositoryPrefixes struct {
	Repositories []RepositoryURLs `json:"repositories"`
	// contains filtered or unexported fields
}

RepositoryPrefixes maps repository prefixes to URLs

func GetRepositoryPrefixes 

func GetRepositoryPrefixes(dir string) (*RepositoryPrefixes, error)

GetRepositoryPrefixes loads the repository prefixes for the version stream

func (*RepositoryPrefixes) PrefixForURL 

func (p *RepositoryPrefixes) PrefixForURL(u string) string

PrefixForURL returns the repository prefix for the given URL

func (*RepositoryPrefixes) URLsForPrefix 

func (p *RepositoryPrefixes) URLsForPrefix(prefix string) []string

URLsForPrefix returns the repository URLs for the given prefix

type RepositoryURLs 

type RepositoryURLs struct {
	Prefix string   `json:"prefix"`
	URLs   []string `json:"urls"`
}

RepositoryURLs contains the prefix and URLS for a repository

type StableVersion 

type StableVersion struct {
	// Indicates that this chart is deprecated and should be replaced with ReplacementChart
	ReplacementChart string `json:"replacementChart,omitempty"`
	// ReplacementChartPrefix can hold a replacement chart prefix in case ReplacementChart is set
	ReplacementChartPrefix string `json:"replacementChartPrefix,omitempty"`

	// Version the default version to use
	Version string `json:"version,omitempty"`

	// e.g. for packages we could use: `{ version: "1.10.1", upperLimit: "1.14.0"}` which would mean these
	// versions are all valid `["1.11.5", "1.13.1234"]` but these are invalid `["1.14.0", "1.14.1"]`
	UpperLimit string `json:"upperLimit,omitempty"`
	// GitURL the URL to the source code
	GitURL string `json:"gitUrl,omitempty"`
	// Component is the component inside the git URL
	Component string `json:"component,omitempty"`
	// URL the URL for the documentation
	URL string `json:"url,omitempty"`
	// Namespace the default namespace to install this chart if none is specified
	Namespace string `json:"namespace,omitempty"`
}

StableVersion stores the stable version information

func LoadStableVersion 

func LoadStableVersion(wrkDir string, kind VersionKind, name string) (*StableVersion, error)

LoadStableVersion loads the stable version data from the version configuration directory returning an empty object if there is no specific stable version configuration available

func LoadStableVersionFile 

func LoadStableVersionFile(path string) (*StableVersion, error)

LoadStableVersionFile loads the stable version data from the given file name

func LoadStableVersionFromData 

func LoadStableVersionFromData(data []byte) (*StableVersion, error)

LoadStableVersionFromData loads the stable version data from the given the data

func (*StableVersion) VerifyPackage 

func (data *StableVersion) VerifyPackage(name string, currentVersion string, workDir string, warnOnMissing bool) error

VerifyPackage verifies the current version of the package is valid

type VersionKind 

type VersionKind string

VersionKind represents the kind of version 

const (
	// KindChart represents a chart version
	KindChart VersionKind = "charts"

	// KindPackage represents a package version
	KindPackage VersionKind = "packages"

	// KindDocker represents a docker resolveImage version
	KindDocker VersionKind = "docker"

	// KindGit represents a git repository (e.g. for jx boot configuration or a build pack)
	KindGit VersionKind = "git"
)

type VersionResolver 

type VersionResolver struct {
	VersionsDir          string
	WarnOnMissingVersion bool
}

VersionResolver resolves versions of charts, packages or docker images

func (*VersionResolver) GetRepositoryPrefixes 

func (v *VersionResolver) GetRepositoryPrefixes() (*RepositoryPrefixes, error)

GetRepositoryPrefixes loads the repository prefixes for the version stream

func (*VersionResolver) ResolveDockerImage 

func (v *VersionResolver) ResolveDockerImage(image string) (string, error)

ResolveDockerImage ensures the given docker image has a valid version if there is one in the version stream

func (*VersionResolver) ResolveGitVersion 

func (v *VersionResolver) ResolveGitVersion(gitURL string) (string, error)

ResolveGitVersion resolves the version to use for the given git repository using the version stream

func (*VersionResolver) StableVersion 

func (v *VersionResolver) StableVersion(kind VersionKind, name string) (*StableVersion, error)

StableVersion returns the stable version of the given kind name

func (*VersionResolver) StableVersionNumber 

func (v *VersionResolver) StableVersionNumber(kind VersionKind, name string) (string, error)

StableVersionNumber returns the stable version number of the given kind name

func (*VersionResolver) VerifyPackage 

func (v *VersionResolver) VerifyPackage(name string, currentVersion string) error

VerifyPackage verifies the package is of a sufficient version

func (*VersionResolver) VerifyPackages 

func (v *VersionResolver) VerifyPackages(packages map[string]string) error

VerifyPackages verifies that the package keys and current version numbers are at the required minimum versions

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.