secret

Documentation

Overview

Package secret provides the defined CLI secret actions for Vela.

Usage:

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

Index

• type Config
  • func (c *Config) Add(client *vela.Client) error
  • func (c *Config) AddFromFile(client *vela.Client) error
  • func (c *Config) Get(client *vela.Client) error
  • func (c *Config) Remove(client *vela.Client) error
  • func (c *Config) Update(client *vela.Client) error
  • func (c *Config) UpdateFromFile(client *vela.Client) error
  • func (c *Config) Validate() error
  • func (c *Config) View(client *vela.Client) error
• type ConfigFile

Types

type Config

type Config struct {
	Action            string
	Engine            string
	Type              string
	Org               string
	Repo              string
	Team              string
	Name              string
	Value             string
	Images            []string
	AllowEvents       []string
	AllowCommand      *bool
	AllowSubstitution *bool
	File              string
	Page              int
	PerPage           int
	Output            string
	Color             output.ColorOptions
}

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

func (*Config) Add

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

Add creates a secret based on the provided configuration.

func (*Config) AddFromFile

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

AddFromFile creates a secret from a file based on the provided configuration.

func (*Config) Get

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

Get captures a list of secrets based on the provided configuration.

func (*Config) Remove

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

Remove deletes a secret based on the provided configuration.

func (*Config) Update

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

Update modifies a secret based on the provided configuration.

func (*Config) UpdateFromFile

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

UpdateFromFile updates a secret from a file based on 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 secret based on the provided configuration.

type ConfigFile

type ConfigFile struct {
	Metadata struct {
		Version string `yaml:"version,omitempty"`
		Engine  string `yaml:"engine,omitempty"`
	} `yaml:"metadata,omitempty"`
	Secrets []*library.Secret `yaml:"secrets,omitempty"`
}

ConfigFile represents the secret configuration necessary to perform secret related requests from a file with Vela.