Skip to content

Commit 634dfc4

Browse files
committed
add description annotation
1 parent 00d8177 commit 634dfc4

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/build/variables/index.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ Global variables can be marked as sensitive (`isSensitive = true`) for storing p
6262
Sensitive variables can only be used in password fields.
6363
Using sensitive variables in other fields or in variable templates fails and does not expose the value.
6464

65+
Global variables can have an optional description (`description = "the description of my global variable"`).
66+
6567
Global variables are set in a section like in the example below:
6668

6769
```conf
@@ -76,16 +78,20 @@ config.variables = {
7678
7779
global = {
7880
# Insert global variables here
81+
82+
# simple notation: key = "value"
7983
jdbcHost = "my-jdbc-host"
80-
# more key/value pairs ...
81-
# key = "value"
82-
#
83-
# sensitive (password) variable example
84-
# non-sensitive variables could use this notation, too
84+
85+
# more variables …
86+
87+
# advanced notation: to add `isSensitive` and/or `description`
8588
jdbcPassword = {
8689
value = "my-secret-password"
90+
description = "the JDBC password for my-jdbc-host"
8791
isSensitive = true
8892
}
93+
94+
# more variables …
8995
}
9096
}
9197
```

0 commit comments

Comments
 (0)