settings

package

v0.28.2 Latest Latest Go to latest Published: Oct 22, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/go-vela/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

The defined CLI settings actions for Vela.

Usage:

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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
	SCM

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

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

	MaxDashboardRepos int32

	Color output.ColorOptions
}

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

func (*Config) Update ¶

func (c *Config) Update(ctx context.Context, client *vela.Client) error

Update modifies settings based off the provided configuration.

func (*Config) UpdateFromFile ¶

func (c *Config) UpdateFromFile(ctx context.Context, 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(ctx context.Context, 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.

type SCM ¶ added in v0.27.0

type SCM struct {
	RepoRoleMap map[string]string
	OrgRoleMap  map[string]string
	TeamRoleMap map[string]string
}

SCM represents the SCM configurations used to modify the SCM settings for Vela.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL