pipeline

Documentation

Overview

nolint: dupl // ignore similar code among actions

Package pipeline provides the defined CLI pipeline actions for Vela.

Usage:

import "github.com/go-vela/cli/action/pipeline"

nolint: dupl // ignore similar code among actions

nolint: dupl // ignore similar code among actions

Index

• type Config
  • func (c *Config) Compile(client *vela.Client) error
  • func (c *Config) Exec(client compiler.Engine) error
  • func (c *Config) Expand(client *vela.Client) error
  • func (c *Config) Generate() error
  • func (c *Config) Validate() error
  • func (c *Config) ValidateLocal(client compiler.Engine) error
  • func (c *Config) ValidateRemote(client *vela.Client) error
  • func (c *Config) View(client *vela.Client) error

Types

type Config

type Config struct {
	Action        string
	Branch        string
	Comment       string
	Event         string
	Tag           string
	Target        string
	Org           string
	Repo          string
	Ref           string
	File          string
	Path          string
	Type          string
	Stages        bool
	Template      bool
	TemplateFiles []string
	Local         bool
	Remote        bool
	Volumes       []string
	Output        string
	PipelineType  string
}

Config represents the configuration necessary to perform pipeline related requests with Vela.

func (*Config) Compile

func (c *Config) Compile(client *vela.Client) error

Compile compiles a pipeline based off the provided configuration.

func (*Config) Exec

func (c *Config) Exec(client compiler.Engine) error

Exec executes a pipeline based off the provided configuration.

func (*Config) Expand

func (c *Config) Expand(client *vela.Client) error

Expand expands a pipeline based off the provided configuration.

func (*Config) Generate

func (c *Config) Generate() error

Generate produces a pipeline based off the provided configuration.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies the configuration provided.

func (*Config) ValidateLocal

func (c *Config) ValidateLocal(client compiler.Engine) error

ValidateLocal verifies a local pipeline based off the provided configuration.

func (*Config) ValidateRemote

func (c *Config) ValidateRemote(client *vela.Client) error

ValidateRemote validates a remote pipeline based off the provided configuration.

func (*Config) View

func (c *Config) View(client *vela.Client) error

View inspects a pipeline based off the provided configuration.