common

Documentation

Index

• func CreateGraphCommand(p cli.Params, fetcher GraphFetcher) *cobra.Command
• func RunGraphCommand(p cli.Params, opts *GraphOptions, fetcher GraphFetcher, args []string) error
• type GraphFetcher
• type GraphOptions
• type Pipeline

Functions

func CreateGraphCommand

func CreateGraphCommand(p cli.Params, fetcher GraphFetcher) *cobra.Command

func RunGraphCommand

func RunGraphCommand(p cli.Params, opts *GraphOptions, fetcher GraphFetcher, args []string) error

Types

type GraphFetcher

type GraphFetcher interface {
	GetByName(cs *cli.Clients, name, namespace string) (*Pipeline, error)
	GetAll(cs *cli.Clients, namespace string) ([]Pipeline, error)
}

GraphFetcher is an interface that defines the methods to fetch the Pipeline

type GraphOptions

type GraphOptions struct {
	OutputFormat string
	OutputDir    string
	WithTaskRef  bool
}

GraphOptions holds the options for the graph command OutputFormat: dot, puml, mmd OutputDir: the directory to save the output files. Otherwise, the output is printed to the screen WithTaskRef: Include TaskRefName information in the output

type Pipeline

type Pipeline struct {
	Name           string
	TektonPipeline v1.Pipeline
}

Holds the Pipeline name and the Pipeline itself, in case of PipelineRun it holds the PipelineRun name and the Pipeline