Skip to content

docs: add variable 'description' attribute #3420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tonistiigi merged 2 commits into from
Sep 10, 2025
Merged

docs: add variable 'description' attribute #3420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b991cb
docs: add variable attribute
aevesdocker Sep 10, 2025
983716a
grammar
aevesdocker Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/bake-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,7 @@ or interpolate them in attribute values in your Bake file.
variable "TAG" {
type = string
default = "latest"
description: "Tag to use for build"
}

target "webapp-dev" {
Expand All @@ -1111,6 +1112,8 @@ You can assign a default value for a variable in the Bake file,
or assign a `null` value to it. If you assign a `null` value,
Buildx uses the default value from the Dockerfile instead.

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.

You can override variable defaults set in the Bake file using environment variables.
The following example sets the `TAG` variable to `dev`,
overriding the default `latest` value shown in the previous example.
Expand Down