Document the purpose of settingAliases [#95]

This commit is contained in:
Erin Call 2020-05-22 15:35:43 -07:00
parent d7a9eccb13
commit 0b17d929a7
No known key found for this signature in database
GPG key ID: 4071FF6C15B8DAD1

View file

@ -144,6 +144,10 @@ func (cfg *Config) deprecationWarn() {
} }
} }
// settingAliases provides alternate environment variable names for certain settings, either because
// they were renamed during drone-helm3's lifetime or for backward-compatibility with the original
// drone-helm. Most config options don't need to be included here; adding them to the main Config
// struct is sufficient.
type settingAliases struct { type settingAliases struct {
Command string `envconfig:"helm_command"` Command string `envconfig:"helm_command"`
AddRepos []string `envconfig:"helm_repos"` AddRepos []string `envconfig:"helm_repos"`