valid

package
v0.4.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2018 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
}

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) 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 added in v0.4.5

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL