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)
- func (p *ParserValidator) ParseRepoCfgData(repoCfgData []byte, globalCfg valid.GlobalCfg, repoID string) (valid.RepoCfg, error)
Constants ¶
const AtlantisYAMLFilename = "atlantis.yaml"
AtlantisYAMLFilename is the name of the config file for each repo.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ParserValidator ¶
type ParserValidator struct{}
ParserValidator parses and validates server-side repo config files and repo-level atlantis.yaml files.
func (*ParserValidator) HasRepoCfg ¶ added in v0.7.0
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 ¶ added in v0.7.0
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 ¶ added in v0.7.0
func (p *ParserValidator) ParseGlobalCfgJSON(cfgJSON string, defaultCfg valid.GlobalCfg) (valid.GlobalCfg, error)
ParseGlobalCfgJSON parses a json string cfgJSON into global config.
func (*ParserValidator) ParseRepoCfg ¶ added in v0.7.0
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).
func (*ParserValidator) ParseRepoCfgData ¶ added in v0.15.0
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package raw contains the golang representations of the YAML elements supported in atlantis.yaml.
|
Package raw contains the golang representations of the YAML elements supported in atlantis.yaml. |
|
Package valid contains the structs representing the atlantis.yaml config after it's been parsed and validated.
|
Package valid contains the structs representing the atlantis.yaml config after it's been parsed and validated. |