From 10e7e7fee5716a8421d2207b98c56281a1e82cda Mon Sep 17 00:00:00 2001 From: Erin Call Date: Mon, 23 Dec 2019 16:45:09 -0800 Subject: [PATCH] Document the Config struct's behavior correctly [#19] [#9] --- internal/helm/config.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/internal/helm/config.go b/internal/helm/config.go index 04c70c6..9e88dab 100644 --- a/internal/helm/config.go +++ b/internal/helm/config.go @@ -6,9 +6,8 @@ import ( // The Config struct captures the `settings` and `environment` blocks in the application's drone // config. Configuration in drone's `settings` block arrives as uppercase env vars matching the -// config key, prefixed with `PLUGIN_`. Config from the `environment` block is *not* prefixed; any -// keys that are likely to be in that block (i.e. things that use `from_secret` need an explicit -// `envconfig:` tag so that envconfig will look for a non-prefixed env var. +// config key, prefixed with `PLUGIN_`. Config from the `environment` block is uppercased, but does +// not have the `PLUGIN_` prefix. It may, however, be prefixed with the value in `$PLUGIN_PREFIX`. type Config struct { // Configuration for drone-helm itself Command string `envconfig:"HELM_COMMAND"` // Helm command to run