dashboard

Documentation

Overview

Package dashboard provides the defined CLI dashboard actions for Vela.

Usage:

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

Index

• type Config
  • func (c *Config) Add(client *vela.Client) error
  • func (c *Config) Get(client *vela.Client) error
  • func (c *Config) Update(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
	Name        string
	ID          string
	AddRepos    []string
	TargetRepos []string
	DropRepos   []string
	Branches    []string
	Events      []string
	AddAdmins   []string
	DropAdmins  []string
	Full        bool
	Output      string
	Color       output.ColorOptions
}

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

func (*Config) Add

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

Add creates a dashboard based off the provided configuration.

func (*Config) Get

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

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

func (*Config) Update

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

Update modifies a dashboard 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 dashboard based off the provided configuration.