Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ParameterList = []Parameter{ { Name: "automerge", Description: "Atlantis automerge config value.", Required: false, DefaultValue: "true", Shorthand: "", }, { Name: "parallel-apply", Description: "Atlantis parallel apply config value.", Required: false, DefaultValue: "true", Shorthand: "", }, { Name: "parallel-plan", Description: "Atlantis parallel plan config value.", Required: false, DefaultValue: "true", Shorthand: "", }, { Name: "terraform-base-dir", Description: "Basedir for terraform resources.", Required: false, DefaultValue: "./", Shorthand: "", }, { Name: "output-file", Description: "Atlantis YAML output file name.", Required: false, DefaultValue: "atlantis.yaml", Shorthand: "f", }, { Name: "output-type", Description: "Atlantis YAML output type. [file|stdout].", Required: false, DefaultValue: "file", Shorthand: "e", }, { Name: "workflow", Description: "Atlantis Workflow to be used. [single-workspace|multi-workspace].", Required: true, DefaultValue: "", Shorthand: "w", }, { Name: "when-modified", Description: "Atlantis will trigger an autoplan when these modifications occur (list of strings).", Required: false, DefaultValue: "**/*.tf,**/*.tfvars,**/*.json,**/*.tpl,**/*.tmpl,**/*.xml", Shorthand: "m", }, { Name: "excluded-projects", Description: "Atlantis regex filter to exclude projects.", Required: false, DefaultValue: "", Shorthand: "x", }, { Name: "included-projects", Description: "Atlantis regex filter to only include projects.", Required: false, DefaultValue: "", Shorthand: "z", }, { Name: "pattern-detector", Description: "discover projects based on files or directories names.", Required: true, DefaultValue: "", Shorthand: "q", }, { Name: "pull-num", Description: "Github Pull Request Number to check diffs.", Required: false, DefaultValue: "", Shorthand: "p", }, { Name: "base-repo-name", Description: "Github Repo Name.", Required: false, DefaultValue: "", Shorthand: "r", }, { Name: "base-repo-owner", Description: "Github Repo Owner Name.", Required: false, DefaultValue: "", Shorthand: "o", }, { Name: "gh-token", Description: "Specify the GitHub token when automatic detection is not possible.", Required: false, DefaultValue: "", Shorthand: "t", }, { Name: "pr-filter", Description: "Filter projects based on the PR changes (Only for github SCM).", Required: false, Dependencies: DependentParameters{ WhenParentParameterIs: "true", ParameterList: []string{"pull-num", "base-repo-name", "base-repo-owner", "gh-token"}}, DefaultValue: "false", Shorthand: "u", }, }
ParameterList is the source of truth list for all parameters
Functions ¶
func CheckRequiredParameters ¶
func GenerateDescription ¶
GenerateDescription generates the description for a parameter
Types ¶
type DependentParameters ¶
Click to show internal directories.
Click to hide internal directories.