deployment

Documentation

Overview

Package deployment provides the defined CLI deployment actions for Vela.

Usage:

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

Index

• type Config
  • func (c *Config) Add(client *vela.Client) error
  • func (c *Config) Get(client *vela.Client) error
  • func (c *Config) Validate() error
  • func (c *Config) View(client *vela.Client) error

Types

type Config

type Config struct {
	Action      string
	Org         string
	Repo        string
	Number      int
	Description string
	Ref         string
	Target      string
	Task        string
	Page        int
	PerPage     int
	Output      string
	Parameters  []string
}

Config represents the configuration necessary to perform deployment related quests with Vela.

func (*Config) Add

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

Add creates a deployment based off the provided configuration.

func (*Config) Get

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

Get captures a list of deployments based off the provided configuration.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies the configuration provided.

func (*Config) View

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

View inspects a deployment based off the provided configuration.