batches

Documentation

Overview

SPDX-License-Identifier: MIT Copyright (c) 2019 Hadrien Chauvin

SPDX-License-Identifier: MIT Copyright (c) 2019 Hadrien Chauvin

Index

• type Batch
  • func Read(config *config.Config, path string) (*Batch, error)
  • func ReadFs(config *config.Config, path string, fs afero.Fs) (*Batch, error)
  • func (batch *Batch) Filter(tagFilter string, focus string) (*Batch, error)
• type BatchCommand
• type Pipeline

Types

type Batch

type Batch struct {
	Pipelines []Pipeline     `yaml:"pipelines"`
	Commands  []BatchCommand `yaml:"commands"`
}

func Read

func Read(config *config.Config, path string) (*Batch, error)

Read reads a pipeline from a file on the local file system. The path is given relative to the workspace root (see config.Config.WorkspaceDir).

The resulting pipeline is expanded: all the base pipelines that are referenced in the pipeline are merged.

func ReadFs

func ReadFs(config *config.Config, path string, fs afero.Fs) (*Batch, error)

ReadFs does the same as Read but on an arbitrary afero file system.

func (*Batch) Filter

func (batch *Batch) Filter(tagFilter string, focus string) (*Batch, error)

type BatchCommand

type BatchCommand struct {
	pipelines.BaseCommand `yaml:",inline"`

	Name      string   `yaml:"name" validate:"required,name"`
	Exclusive bool     `yaml:"exclusive"`
	Tags      []string `yaml:"tags" validate:"name"`
	DependsOn []string `yaml:"dependsOn" validate:"name"`
	Pipelines []string `yaml:"pipelines"`
	Flaky     bool     `yaml:"flaky"`
}

type Pipeline

type Pipeline struct {
	Name      string `yaml:"name" validate:"required,name"`
	Path      string `yaml:"path" validate:"required"`
	Setup     string `yaml:"setup"`
	TagFilter string `yaml:"tagFilter"`
}