schedule

Documentation

Overview

Package schedule provides the defined CLI schedule actions for Vela.

Usage:

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

Index

• type Config
  • func (c *Config) Add(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) Validate() error
  • func (c *Config) View(client *vela.Client) error

Types

type Config

type Config struct {
	Action  string
	Org     string
	Repo    string
	Active  bool
	Name    string
	Entry   string
	Page    int
	PerPage int
	Output  string
	Branch  string
	Color   output.ColorOptions
}

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

func (*Config) Add

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

Add creates a schedule based off the provided configuration.

func (*Config) Get

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

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

func (*Config) Remove

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

Remove deletes a schedule based off the provided configuration.

func (*Config) Update

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

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