valid

Documentation

Overview

Package valid contains the structs representing the atlantis.yaml config after it's been parsed and validated.

Index

• type Autoplan
• type Config
  • func (c Config) FindProjectByName(name string) *Project
  • func (c Config) FindProjectsByDir(dir string) []Project
  • func (c Config) FindProjectsByDirWorkspace(dir string, workspace string) []Project
  • func (c Config) GetApplyStage(workflowName string) *Stage
  • func (c Config) GetPlanStage(workflowName string) *Stage
• type Project
  • func (p Project) GetName() string
• type Stage
• type Step
• type Workflow

Types

type Autoplan

type Autoplan struct {
	WhenModified []string
	Enabled      bool
}

type Config

type Config struct {
	// Version is the version of the atlantis YAML file. Will always be equal
	// to 2.
	Version   int
	Projects  []Project
	Workflows map[string]Workflow
	Automerge bool
}

Config is the atlantis.yaml config after it's been parsed and validated.

func (Config) FindProjectByName

func (c Config) FindProjectByName(name string) *Project

func (Config) FindProjectsByDir

func (c Config) FindProjectsByDir(dir string) []Project

FindProjectsByDir returns all projects that are in dir.

func (Config) FindProjectsByDirWorkspace

func (c Config) FindProjectsByDirWorkspace(dir string, workspace string) []Project

func (Config) GetApplyStage

func (c Config) GetApplyStage(workflowName string) *Stage

func (Config) GetPlanStage

func (c Config) GetPlanStage(workflowName string) *Stage

type Project

type Project struct {
	Dir               string
	Workspace         string
	Name              *string
	Workflow          *string
	TerraformVersion  *version.Version
	Autoplan          Autoplan
	ApplyRequirements []string
}

func (Project) GetName

func (p Project) GetName() string

GetName returns the name of the project or an empty string if there is no project name.

type Stage

type Stage struct {
	Steps []Step
}

type Step

type Step struct {
	StepName   string
	ExtraArgs  []string
	RunCommand []string
}

type Workflow

type Workflow struct {
	Apply *Stage
	Plan  *Stage
}