Get password in example from environment (#190)

* get password in example from environment

Signed-off-by: Sven Schliesing <s.schliesing@ndr.de>

* Updared README and grammar.

Signed-off-by: bwplotka <bwplotka@gmail.com>

---------

Signed-off-by: Sven Schliesing <s.schliesing@ndr.de>
Signed-off-by: bwplotka <bwplotka@gmail.com>
Co-authored-by: bwplotka <bwplotka@gmail.com>

Author: muffl0n

README.md

@@ -55,6 +55,8 @@ The configuration file is essentially a list of receivers matching 1-to-1 all Al
 
 Each receiver must have a unique name (matching the Alertmanager receiver name), JIRA API access fields (URL, username and password), a handful of required issue fields (such as the JIRA project and issue summary), some optional issue fields (e.g. priority) and a `fields` map for other (standard or custom) JIRA fields. Most of these may use [Go templating](https://golang.org/pkg/text/template/) to generate the actual field values based on the contents of the Alertmanager notification. The exact same data structures and functions as those defined in the [Alertmanager template reference](https://prometheus.io/docs/alerting/notifications/) are available in JIRAlert.
 
+Similar to Alertmanager, jiralert supports environment variable substitution with the `$(...)` syntax.
+
 ## Alertmanager configuration
 
 To enable Alertmanager to talk to JIRAlert you need to configure a webhook in Alertmanager. You can do that by adding a webhook receiver to your Alertmanager configuration. 

examples/jiralert.yml

@@ -4,7 +4,8 @@ defaults:
   # API access fields.
   api_url: https://jiralert.atlassian.net
   user: jiralert
-  password: 'JIRAlert'
+  # Get password from the $PASSWORD environment variable.
+  password: $(PASSWORD)
   # Alternatively to user and password use a Personal Access Token
   # personal_access_token: "Your Personal Access Token". See https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html
 

pkg/config/config_test.go

@@ -98,7 +98,6 @@ func TestLoadFile(t *testing.T) {
 
 // Checks if the env var substitution is happening correctly in the loaded file
 func TestEnvSubstitution(t *testing.T) {
-
 	config := "user: $(JA_USER)"
 	os.Setenv("JA_USER", "user")
 
@@ -110,7 +109,6 @@ func TestEnvSubstitution(t *testing.T) {
 	config = "user: $(JA_MISSING)"
 	_, err = substituteEnvVars([]byte(config), log.NewNopLogger())
 	require.Error(t, err)
-
 }
 
 // A test version of the ReceiverConfig struct to create test yaml fixtures.