Skip to content

Commit a67c877

Browse files
authored
Merge pull request #3420 from aevesdocker/ENGDOCS-2991
docs: add variable 'description' attribute
2 parents 3922da8 + 983716a commit a67c877

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/bake-reference.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,6 +1099,7 @@ or interpolate them in attribute values in your Bake file.
10991099
variable "TAG" {
11001100
type = string
11011101
default = "latest"
1102+
description: "Tag to use for build"
11021103
}
11031104
11041105
target "webapp-dev" {
@@ -1111,6 +1112,8 @@ You can assign a default value for a variable in the Bake file,
11111112
or assign a `null` value to it. If you assign a `null` value,
11121113
Buildx uses the default value from the Dockerfile instead.
11131114

1115+
You can also add a description of the variable's purpose with the `description` field. This attribute is useful when combined with the `docker buildx bake --list=variables` option, providing a more informative output when listing the available variables in a Bake file.
1116+
11141117
You can override variable defaults set in the Bake file using environment variables.
11151118
The following example sets the `TAG` variable to `dev`,
11161119
overriding the default `latest` value shown in the previous example.

0 commit comments

Comments
 (0)