raw

Documentation

Overview

Package raw contains the golang representations of the YAML elements supported in atlantis.yaml. The structs here represent the exact data that comes from the file before it is parsed/validated further.

Index

• Constants
• Variables
• func DefaultAutoPlan() valid.Autoplan
• type Autoplan
  • func (a Autoplan) ToValid() valid.Autoplan
  • func (a Autoplan) Validate() error
• type GlobalCfg
  • func (g GlobalCfg) ToValid(defaultCfg valid.GlobalCfg) valid.GlobalCfg
  • func (g GlobalCfg) Validate() error
• type Project
  • func (p Project) ToValid() valid.Project
  • func (p Project) Validate() error
• type Repo
  • func (r Repo) HasRegexID() bool
  • func (r Repo) ToValid(workflows map[string]valid.Workflow) valid.Repo
  • func (r Repo) Validate() error
• type RepoCfg
  • func (r RepoCfg) ToValid() valid.RepoCfg
  • func (r RepoCfg) Validate() error
• type Stage
  • func (s Stage) ToValid() valid.Stage
  • func (s Stage) Validate() error
• type Step
  • func (s *Step) MarshalJSON() ([]byte, error)
  • func (s Step) MarshalYAML() (interface{}, error)
  • func (s Step) ToValid() valid.Step
  • func (s *Step) UnmarshalJSON(data []byte) error
  • func (s *Step) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (s Step) Validate() error
• type Workflow
  • func (w Workflow) ToValid(name string) valid.Workflow
  • func (w Workflow) Validate() error

Constants

const (
	DefaultWorkspace          = "default"
	ApprovedApplyRequirement  = "approved"
	MergeableApplyRequirement = "mergeable"
)

const (
	ExtraArgsKey  = "extra_args"
	NameArgKey    = "name"
	CommandArgKey = "command"
	ValueArgKey   = "value"
	RunStepName   = "run"
	PlanStepName  = "plan"
	ApplyStepName = "apply"
	InitStepName  = "init"
	EnvStepName   = "env"
)

const DefaultAutomerge = false

DefaultAutomerge is the default setting for automerge.

const DefaultParallelApply = false

DefaultParallelApply is the default setting for parallel apply

const DefaultParallelPlan = false

DefaultParallelPlan is the default setting for parallel plan

Variables

var DefaultAutoPlanWhenModified = []string{"**/*.tf*", "**/terragrunt.hcl"}

DefaultAutoPlanWhenModified is the default element in the when_modified list if none is defined.

Functions

func DefaultAutoPlan

func DefaultAutoPlan() valid.Autoplan

DefaultAutoPlan returns the default autoplan config.

Types

type Autoplan

type Autoplan struct {
	WhenModified []string `yaml:"when_modified,omitempty"`
	Enabled      *bool    `yaml:"enabled,omitempty"`
}

func (Autoplan) ToValid

func (a Autoplan) ToValid() valid.Autoplan

func (Autoplan) Validate

func (a Autoplan) Validate() error

type GlobalCfg

type GlobalCfg struct {
	Repos     []Repo              `yaml:"repos" json:"repos"`
	Workflows map[string]Workflow `yaml:"workflows" json:"workflows"`
}

GlobalCfg is the raw schema for server-side repo config.

func (GlobalCfg) ToValid

func (g GlobalCfg) ToValid(defaultCfg valid.GlobalCfg) valid.GlobalCfg

func (GlobalCfg) Validate

func (g GlobalCfg) Validate() error

type Project

type Project struct {
	Name              *string   `yaml:"name,omitempty"`
	Dir               *string   `yaml:"dir,omitempty"`
	Workspace         *string   `yaml:"workspace,omitempty"`
	Workflow          *string   `yaml:"workflow,omitempty"`
	TerraformVersion  *string   `yaml:"terraform_version,omitempty"`
	Autoplan          *Autoplan `yaml:"autoplan,omitempty"`
	ApplyRequirements []string  `yaml:"apply_requirements,omitempty"`
}

func (Project) ToValid

func (p Project) ToValid() valid.Project

func (Project) Validate

func (p Project) Validate() error

type Repo

type Repo struct {
	ID                   string   `yaml:"id" json:"id"`
	ApplyRequirements    []string `yaml:"apply_requirements" json:"apply_requirements"`
	Workflow             *string  `yaml:"workflow,omitempty" json:"workflow,omitempty"`
	AllowedOverrides     []string `yaml:"allowed_overrides" json:"allowed_overrides"`
	AllowCustomWorkflows *bool    `yaml:"allow_custom_workflows,omitempty" json:"allow_custom_workflows,omitempty"`
}

Repo is the raw schema for repos in the server-side repo config.

func (Repo) HasRegexID

func (r Repo) HasRegexID() bool

HasRegexID returns true if r is configured with a regex id instead of an exact match id.

func (Repo) ToValid

func (r Repo) ToValid(workflows map[string]valid.Workflow) valid.Repo

func (Repo) Validate

func (r Repo) Validate() error

type RepoCfg

type RepoCfg struct {
	Version       *int                `yaml:"version,omitempty"`
	Projects      []Project           `yaml:"projects,omitempty"`
	Workflows     map[string]Workflow `yaml:"workflows,omitempty"`
	Automerge     *bool               `yaml:"automerge,omitempty"`
	ParallelApply *bool               `yaml:"parallel_apply,omitempty"`
	ParallelPlan  *bool               `yaml:"parallel_plan,omitempty"`
}

RepoCfg is the raw schema for repo-level atlantis.yaml config.

func (RepoCfg) ToValid

func (r RepoCfg) ToValid() valid.RepoCfg

func (RepoCfg) Validate

func (r RepoCfg) Validate() error

type Stage

type Stage struct {
	Steps []Step `yaml:"steps,omitempty" json:"steps,omitempty"`
}

func (Stage) ToValid

func (s Stage) ToValid() valid.Stage

func (Stage) Validate

func (s Stage) Validate() error

type Step

type Step struct {
	// Key will be set in case #1 and #3 above to the key. In case #2, there
	// could be multiple keys (since the element is a map) so we don't set Key.
	Key *string
	// Env will be set in case #2 above.
	Env map[string]map[string]string
	// Map will be set in case #3 above.
	Map map[string]map[string][]string
	// StringVal will be set in case #4 above.
	StringVal map[string]string
}

Step represents a single action/command to perform. In YAML, it can be set as 1. A single string for a built-in command:

• init
• plan

2. A map for an env step with name and command or value

• env: name: test command: echo 312 value: value

3. A map for a built-in command and extra_args:

• plan: extra_args: [-var-file=staging.tfvars]

4. A map for a custom run command:

• run: my custom command

Here we parse step in the most generic fashion possible. See fields for more details.

func (*Step) MarshalJSON

func (s *Step) MarshalJSON() ([]byte, error)

func (Step) MarshalYAML

func (s Step) MarshalYAML() (interface{}, error)

func (Step) ToValid

func (s Step) ToValid() valid.Step

func (*Step) UnmarshalJSON

func (s *Step) UnmarshalJSON(data []byte) error

func (*Step) UnmarshalYAML

func (s *Step) UnmarshalYAML(unmarshal func(interface{}) error) error

func (Step) Validate

func (s Step) Validate() error

type Workflow

type Workflow struct {
	Apply *Stage `yaml:"apply,omitempty" json:"apply,omitempty"`
	Plan  *Stage `yaml:"plan,omitempty" json:"plan,omitempty"`
}

func (Workflow) ToValid

func (w Workflow) ToValid(name string) valid.Workflow

func (Workflow) Validate

func (w Workflow) Validate() error