auto

Documentation

Index

• func CompareIndexFiles(rootFs billy.Filesystem) error
• func ValidatePullRequest(token, prNum string, dep *lifecycle.Dependencies) error
• type Bump
  • func SetupBump(repoRoot, targetPackage, targetBranch string, ...) (*Bump, error)
  • func (b *Bump) BumpChart() error
• type Command
• type ForwardPort
  • func CreateForwardPortStructure(ld *lifecycle.Dependencies, assetsToPort map[string][]lifecycle.Asset, ...) (*ForwardPort, error)
  • func (f *ForwardPort) ExecuteForwardPort(chart string) error
• type PullRequest
• type Release
  • func InitRelease(d *lifecycle.Dependencies, s *lifecycle.Status, v, c, f string) (*Release, error)
  • func (r *Release) PullAsset() error
  • func (r *Release) UpdateReleaseYaml() error

Functions

func CompareIndexFiles

func CompareIndexFiles(rootFs billy.Filesystem) error

CompareIndexFiles will load the current index.yaml file from the root filesystem and compare it with the index.yaml file from charts.rancher.io

func ValidatePullRequest

func ValidatePullRequest(token, prNum string, dep *lifecycle.Dependencies) error

ValidatePullRequest will execute the check a given pull request for the following:

• Checkpoint 0: release.yaml file is valid
• TODO: Checkpoint 1: Compare contents of assets/ to charts/
• TODO: Checkpoint 2: Compare assets against index.yaml

Types

type Bump

type Bump struct {
	Pkg *charts.Package
	// contains filtered or unexported fields
}

Bump TODO: Doc this

func SetupBump

func SetupBump(repoRoot, targetPackage, targetBranch string, chScriptOpts *options.ChartsScriptOptions) (*Bump, error)

SetupBump TODO: add description

func (*Bump) BumpChart

func (b *Bump) BumpChart() error

BumpChart will execute a similar approach as the defined development workflow for chartowners. The main difference is that between the steps: (make prepare and make patch) we will calculate the next version to release.

type Command

type Command struct {
	Chart   string   // The chart to forward-port
	Version string   // The version to forward-port
	Command []string // The command to run to forward-port
}

Command holds the necessary information to forward-port a chart

type ForwardPort

type ForwardPort struct {
	VR *lifecycle.VersionRules
	// contains filtered or unexported fields
}

ForwardPort holds the data and methods to forward-port charts

func CreateForwardPortStructure

func CreateForwardPortStructure(ld *lifecycle.Dependencies, assetsToPort map[string][]lifecycle.Asset, forkURL string) (*ForwardPort, error)

CreateForwardPortStructure will create the ForwardPort struct with access to the necessary dependencies. It will also check if yq command is installed on the system.

func (*ForwardPort) ExecuteForwardPort

func (f *ForwardPort) ExecuteForwardPort(chart string) error

ExecuteForwardPort will execute all steps to organize and create the forward-port PRs

type PullRequest

type PullRequest struct {
	// contains filtered or unexported fields
}

PullRequest represents a pull request to be created for each chart separately

type Release

type Release struct {
	VR              *lifecycle.VersionRules
	AssetTgz        string
	AssetPath       string
	ChartVersion    string
	Chart           string
	ReleaseYamlPath string
	ForkRemoteURL   string
	// contains filtered or unexported fields
}

Release holds necessary metadata to release a chart version

func InitRelease

func InitRelease(d *lifecycle.Dependencies, s *lifecycle.Status, v, c, f string) (*Release, error)

InitRelease will create the Release struct with access to the necessary dependencies.

func (*Release) PullAsset

func (r *Release) PullAsset() error

PullAsset will execute the release porting for a chart in the repository

func (*Release) UpdateReleaseYaml

func (r *Release) UpdateReleaseYaml() error

UpdateReleaseYaml reads and parse the release.yaml file to a struct, appends the new version and writes it back to the file.