repocfg

Documentation

Index

• Variables
• type Component
• type ErrNewProject
  • func (e ErrNewProject) Error() string
• type ExtRawProject
  • func ProjectsFrom(c Component, opts Options) ([]ExtRawProject, error)
  • func (p *ExtRawProject) AutoPlan(v string)
  • func (p *ExtRawProject) DefaultTerraformVersion(v string)
• type ExtRawRepoCfg
  • func NewRepoCfg(components []Component, opts Options) (*ExtRawRepoCfg, error)
  • func (rc *ExtRawRepoCfg) MarshalYAML() (interface{}, error)
• type Options

Variables

var ErrNoExistingConfig = fmt.Errorf("no existing config found")

Types

type Component

type Component struct {
	Path     string
	VarFiles []string
}

Component represents a Terraform component and its associated Terraform variable files

type ErrNewProject

type ErrNewProject struct {
	Err       error
	Component Component
	Project   *ExtRawProject
}

ErrProjectFrom represents an error when creating an Atlantis project from a Terraform component along with some useful contextual information.

func (ErrNewProject) Error

func (e ErrNewProject) Error() string

Stringer implementation for ErrProjectFrom

type ExtRawProject

type ExtRawProject struct {
	raw.Project
}

ExtRawProject extends the raw.Project type to add additional methods

func ProjectsFrom

func ProjectsFrom(c Component, opts Options) ([]ExtRawProject, error)

ProjectsFrom creates an Atlantis project from a Terraform component and its associated Terraform variable files.

func (*ExtRawProject) AutoPlan

func (p *ExtRawProject) AutoPlan(v string)

AutoPlan sets the autoplan configuration for the project

This will trigger a plan when the Terraform files or the variable files are modified.

func (*ExtRawProject) DefaultTerraformVersion

func (p *ExtRawProject) DefaultTerraformVersion(v string)

DefaultTerraformVersion sets the default Terraform version for the project if the version is valid.

type ExtRawRepoCfg

type ExtRawRepoCfg struct {
	raw.RepoCfg `yaml:",inline"`
}

ExtRawRepoCfg is an embedded type for a raw.RepoCfg

func NewRepoCfg

func NewRepoCfg(components []Component, opts Options) (*ExtRawRepoCfg, error)

NewRepoCfg returns a new Atlantis RepoCfg from a slice of components and options.

Reference: https://www.runatlantis.io/docs/repo-level-atlantis-yaml.html

func (*ExtRawRepoCfg) MarshalYAML

func (rc *ExtRawRepoCfg) MarshalYAML() (interface{}, error)

type Options

type Options struct {
	Automerge               bool
	Autoplan                bool
	DefaultTerraformVersion string
	Parallel                bool
	UseWorkspaces           bool
}

Options represents the top-level configuration for a new Atlantis RepoCfg