syntax

Documentation

Index

• func NewCmdStepSyntax(commonOpts *opts.CommonOptions) *cobra.Command
• func NewCmdStepSyntaxEffective(commonOpts *opts.CommonOptions) *cobra.Command
• func NewCmdStepSyntaxSchema(commonOpts *opts.CommonOptions) *cobra.Command
• func NewCmdStepSyntaxValidate(commonOpts *opts.CommonOptions) *cobra.Command
• func NewCmdStepSyntaxValidateBuildPacks(commonOpts *opts.CommonOptions) *cobra.Command
• func NewCmdStepSyntaxValidatePipeline(commonOpts *opts.CommonOptions) *cobra.Command
• type StepSyntaxEffectiveOptions
  • func (o *StepSyntaxEffectiveOptions) CreateEffectivePipeline(packsDir string, projectConfig *config.ProjectConfig, projectConfigFile string, ...) (*config.ProjectConfig, error)
  • func (o *StepSyntaxEffectiveOptions) LoadProjectConfig(workingDir string) (*config.ProjectConfig, string, error)
  • func (o *StepSyntaxEffectiveOptions) Run() error
• type StepSyntaxOptions
  • func (o *StepSyntaxOptions) Run() error
• type StepSyntaxSchemaOptions
  • func (o *StepSyntaxSchemaOptions) Run() error
• type StepSyntaxValidateBuildPacksOptions
  • func (o *StepSyntaxValidateBuildPacksOptions) Run() error
• type StepSyntaxValidateOptions
  • func (o *StepSyntaxValidateOptions) Run() error
• type StepSyntaxValidatePipelineOptions
  • func (o *StepSyntaxValidatePipelineOptions) Run() error

Functions

func NewCmdStepSyntax

func NewCmdStepSyntax(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntax Steps a command object for the "step" command

func NewCmdStepSyntaxEffective

func NewCmdStepSyntaxEffective(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntaxEffective Creates a new Command object

func NewCmdStepSyntaxSchema

func NewCmdStepSyntaxSchema(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntaxSchema Steps a command object for the "step" command

func NewCmdStepSyntaxValidate

func NewCmdStepSyntaxValidate(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntaxValidate Steps a command object for the "step" command

func NewCmdStepSyntaxValidateBuildPacks

func NewCmdStepSyntaxValidateBuildPacks(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntaxValidateBuildPacks Creates a new Command object

func NewCmdStepSyntaxValidatePipeline

func NewCmdStepSyntaxValidatePipeline(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStepSyntaxValidatePipeline Creates a new Command object

Types

type StepSyntaxEffectiveOptions

type StepSyntaxEffectiveOptions struct {
	step.StepOptions

	Pack              string
	BuildPackURL      string
	BuildPackRef      string
	Context           string
	CustomImage       string
	DefaultImage      string
	UseKaniko         bool
	KanikoImage       string
	ProjectID         string
	DockerRegistry    string
	DockerRegistryOrg string
	SourceName        string
	CustomEnvs        []string
	OutputFile        string
	ShortView         bool

	ValidateInCluster bool

	PodTemplates map[string]*corev1.Pod

	GitInfo         *gits.GitRepository
	VersionResolver *versionstream.VersionResolver
}

StepSyntaxEffectiveOptions contains the command line flags

func (*StepSyntaxEffectiveOptions) CreateEffectivePipeline

func (o *StepSyntaxEffectiveOptions) CreateEffectivePipeline(packsDir string, projectConfig *config.ProjectConfig, projectConfigFile string, resolver jenkinsfile.ImportFileResolver) (*config.ProjectConfig, error)

CreateEffectivePipeline takes a project config and generates the effective version of the pipeline for it, including build packs, inheritance, overrides, defaults, etc.

func (*StepSyntaxEffectiveOptions) LoadProjectConfig

func (o *StepSyntaxEffectiveOptions) LoadProjectConfig(workingDir string) (*config.ProjectConfig, string, error)

LoadProjectConfig loads the pipeline config from the given workingDir

func (*StepSyntaxEffectiveOptions) Run

func (o *StepSyntaxEffectiveOptions) Run() error

Run implements this command

type StepSyntaxOptions

type StepSyntaxOptions struct {
	step.StepOptions
}

StepSyntaxOptions contains the command line flags

func (*StepSyntaxOptions) Run

func (o *StepSyntaxOptions) Run() error

Run implements this command

type StepSyntaxSchemaOptions

type StepSyntaxSchemaOptions struct {
	step.StepOptions

	Pipeline     bool
	BuildPack    bool
	Requirements bool
	Pod          bool
	Out          string
}

StepSyntaxSchemaOptions contains the command line flags

func (*StepSyntaxSchemaOptions) Run

func (o *StepSyntaxSchemaOptions) Run() error

Run implements this command

type StepSyntaxValidateBuildPacksOptions

type StepSyntaxValidateBuildPacksOptions struct {
	step.StepOptions
}

StepSyntaxValidateBuildPacksOptions contains the command line flags

func (*StepSyntaxValidateBuildPacksOptions) Run

func (o *StepSyntaxValidateBuildPacksOptions) Run() error

Run implements this command

type StepSyntaxValidateOptions

type StepSyntaxValidateOptions struct {
	step.StepOptions
}

StepSyntaxValidateOptions contains the command line flags

func (*StepSyntaxValidateOptions) Run

func (o *StepSyntaxValidateOptions) Run() error

Run implements this command

type StepSyntaxValidatePipelineOptions

type StepSyntaxValidatePipelineOptions struct {
	step.StepOptions

	Context string
	Dir     string
}

StepSyntaxValidatePipelineOptions contains the command line flags

func (*StepSyntaxValidatePipelineOptions) Run

func (o *StepSyntaxValidatePipelineOptions) Run() error

Run implements this command