yaml

Documentation

Index

• Constants
• type ParserValidator
  • func (p *ParserValidator) HasRepoCfg(absRepoDir string) (bool, error)
  • func (p *ParserValidator) ParseGlobalCfg(configFile string, defaultCfg valid.GlobalCfg) (valid.GlobalCfg, error)
  • func (p *ParserValidator) ParseGlobalCfgJSON(cfgJSON string, defaultCfg valid.GlobalCfg) (valid.GlobalCfg, error)
  • func (p *ParserValidator) ParseRepoCfg(absRepoDir string, globalCfg valid.GlobalCfg, repoID string) (valid.RepoCfg, error)

Constants

const AtlantisYAMLFilename = "atlantis.yaml"

AtlantisYAMLFilename is the name of the config file for each repo.

Types

type ParserValidator

type ParserValidator struct{}

ParserValidator parses and validates server-side repo config files and repo-level atlantis.yaml files.

func (*ParserValidator) HasRepoCfg

func (p *ParserValidator) HasRepoCfg(absRepoDir string) (bool, error)

HasRepoCfg returns true if there is a repo config (atlantis.yaml) file for the repo at absRepoDir. Returns an error if for some reason it can't read that directory.

func (*ParserValidator) ParseGlobalCfg

func (p *ParserValidator) ParseGlobalCfg(configFile string, defaultCfg valid.GlobalCfg) (valid.GlobalCfg, error)

ParseGlobalCfg returns the parsed and validated global repo config file at configFile. defaultCfg will be merged into the parsed config. If there is no file at configFile it will return an error.

func (*ParserValidator) ParseGlobalCfgJSON

func (p *ParserValidator) ParseGlobalCfgJSON(cfgJSON string, defaultCfg valid.GlobalCfg) (valid.GlobalCfg, error)

ParseGlobalCfgJSON parses a json string cfgJSON into global config.

func (*ParserValidator) ParseRepoCfg

func (p *ParserValidator) ParseRepoCfg(absRepoDir string, globalCfg valid.GlobalCfg, repoID string) (valid.RepoCfg, error)

ParseRepoCfg returns the parsed and validated atlantis.yaml config for the repo at absRepoDir. If there was no config file, it will return an os.IsNotExist(error).