settings

Documentation

Overview

The defined CLI settings actions for Vela.

Usage:

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

Index

• type Compiler
• type Config
  • 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
• type Queue

Types

type Compiler

type Compiler struct {
	CloneImage        *string
	TemplateDepth     *int
	StarlarkExecLimit *int64
}

Compiler represents the compiler configurations used to modify the compiler settings for Vela.

type Config

type Config struct {
	Action string
	Output string
	File   string
	Compiler
	Queue

	RepoAllowlist          *[]string
	RepoAllowlistAddRepos  []string
	RepoAllowlistDropRepos []string

	ScheduleAllowlist          *[]string
	ScheduleAllowlistAddRepos  []string
	ScheduleAllowlistDropRepos []string

	Color output.ColorOptions
}

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

func (*Config) Update

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

Update modifies settings based off the provided configuration.

func (*Config) UpdateFromFile

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

UpdateFromFile updates 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 settings based off the provided configuration.

type ConfigFile

type ConfigFile struct {
	*settings.Platform `yaml:"platform,omitempty"`
}

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

type Queue

type Queue struct {
	Routes     *[]string
	AddRoutes  []string
	DropRoutes []string
}

Queue represents the compiler configurations used to modify the queue settings for Vela.