upgrade

Documentation

Overview

Package render implements the template rendering related subcommands.

Index

• type Command
  • func (c *Command) Desc() string
  • func (c *Command) Flags() *cli.FlagSet
  • func (c *Command) Help() string
  • func (c *Command) PredictArgs() complete.Predictor
  • func (c *Command) Run(ctx context.Context, args []string) error
• type Flags
  • func (f *Flags) Register(set *cli.FlagSet)

Types

type Command

type Command struct {
	cli.BaseCommand
	// contains filtered or unexported fields
}

Command implements cli.Command for template upgrades.

func (*Command) Desc

func (c *Command) Desc() string

Desc implements cli.Command.

func (*Command) Flags

func (c *Command) Flags() *cli.FlagSet

func (*Command) Help

func (c *Command) Help() string

Help implements cli.Command.

func (*Command) PredictArgs

func (c *Command) PredictArgs() complete.Predictor

func (*Command) Run

func (c *Command) Run(ctx context.Context, args []string) error

type Flags

type Flags struct {
	Location string

	// See common/flags.AcceptDefaults().
	AcceptDefaults bool

	// A list of files that were...
	//   - changed in place by a previous render operation...
	//   - then an upgrade operation was attempted, which attempted to undo the
	//     change by applying the reversal patch in the manifest...
	//   - but the patch failed to apply cleanly...
	//   - and the user was asked to manually resolve the conflict by manually
	//     applying the .rej rejected patch file...
	//   - which the user did, and removed the patch file...
	//   - which means that we can resume the upgrade operation, without needing
	//     to patch these files, because they've already been patched.
	//
	// So basically it's a set of included-from-destination files that will be
	// skipped when doing the phase of the upgrade operation that tries to
	// reverse changes that were previously made to modifed-in-place files.
	AlreadyResolved []string

	// See common/flags.DebugScratchContents().
	DebugScratchContents bool

	// See common/flags.DebugStepDiffs().
	DebugStepDiffs bool

	// Continue upgrading even if the dirhash matches between the
	// already-installed template version and the to-be-installed template
	// version. This is useful to for the manifest to be rewritten with a new
	// template_location field when running with --template-location=foo.
	ContinueIfCurrent bool

	// See common/flags.GitProtocol().
	GitProtocol string

	// See common/flags.Inputs().
	Inputs map[string]string

	// See common/flags.InputFiles().
	InputFiles []string

	// See common/flags.KeepTempDirs().
	KeepTempDirs bool

	// An optional CEL expression which will be evaluated against each manifest
	// that is found; only those where the expression is true will be upgraded.
	ManifestFilter string

	// The manifest to start with, when upgrading multiple manifests. This is
	// used when a previous upgrade operation required manual intervention, and
	// the manual intervention is done, and the user wants to resume.
	ResumeFrom string

	// See common/flags.Prompt().
	Prompt bool

	// See common/flags.SkipInputValidation().
	SkipInputValidation bool

	// Upgrade to the template specified by this location, rather than the
	// template location stored in the manifest (which is the default).
	TemplateLocation string

	// See common/flags.UpgradeChannel().
	UpgradeChannel string

	Verbose bool

	// The template version to upgrade to. If not specified, the underlying
	// upgrade library will use the upgrade track specified in the manifest.
	Version string
}

func (*Flags) Register

func (f *Flags) Register(set *cli.FlagSet)