Fix config --variables not honoring the --format flag #12809

alessio-perugini · 2025-05-06T17:20:18Z

What I did

Added missing format option to the formatter.Print function.
Handling the yaml case separately, as it's not supported by the formatter.Print function. Maybe we can extend that function by adding support for yaml?

Before:

NAME                   REQUIRED            DEFAULT VALUE          ALTERNATE VALUE
DOCKER_REGISTRY_BASE   false               ubuntu/ubuntu:latest
BIND_PORT              false               8100
BIND_ADDRESS           false               127.0.0.1

After:

{
    "BIND_ADDRESS": {
        "Name": "BIND_ADDRESS",
        "DefaultValue": "127.0.0.1",
        "PresenceValue": "",
        "Required": false
    },
    "BIND_PORT": {
        "Name": "BIND_PORT",
        "DefaultValue": "8100",
        "PresenceValue": "",
        "Required": false
    },
    "DOCKER_REGISTRY_BASE": {
        "Name": "DOCKER_REGISTRY_BASE",
        "DefaultValue": "ubuntu/ubuntu:latest",
        "PresenceValue": "",
        "Required": false
    }
}

Related issue

closes #12808

I've noticed that all the other flags that produce some kind of output like --services don't honor the --format flag.
Most of them just return a raw fmt.Println.

When diving deeper into the fix, I've noticed that the format flag defaults to yaml, even when not explicitly provided, and is used only by the default config command without any flags.

I've opted to change the default value to an empty string and override that if we are going to execute the runConfig func. This shouldn't break the old behavior, but I could be wrong here.

Cute animal photo

When providing the --variables with --format flag, the current implementation always printed in human readable form. This patch correctly add the missing format in the formatter.Print function, making the commands behave as an user would expect. Example: `config --variables --format json` Signed-off-by: Alessio Perugini <alessio@perugini.xyz>

Signed-off-by: Alessio Perugini <alessio@perugini.xyz>

ndeloof · 2025-05-06T17:54:27Z

run make docs to update docs after flag update

Signed-off-by: Alessio Perugini <alessio@perugini.xyz>

alessio-perugini · 2025-05-06T18:55:34Z

@ndeloof done in 7558912

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/compose](https://github.com/docker/compose) | minor | `v2.34.0` -> `v2.36.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>docker/compose (docker/compose)</summary> ### [`v2.36.0`](https://github.com/docker/compose/releases/tag/v2.36.0) [Compare Source](docker/compose@v2.35.1...v2.36.0) #### What's Changed 🎉 You can now use external binaries as service provider to extend Compose behaviour. For more information about creating your own plugin check [the documentation](https://github.com/docker/compose/blob/main/docs/extension.md) ##### ✨ Improvements - Introduce `networks.interface_name` by [@ndeloof](https://github.com/ndeloof) in docker/compose#12771 - Add support for `COMPOSE_PROGRESS` env variable by [@AnvarU](https://github.com/AnvarU) in docker/compose#12769 - Document extensibility using service.provider and open provider to external binaries by [@ndeloof](https://github.com/ndeloof) in docker/compose#12777 - Introduce build `--check` by [@ndeloof](https://github.com/ndeloof) in docker/compose#12765 ##### 🐛 Fixes - Build: write `--print` output to stdout by [@emersion](https://github.com/emersion) in docker/compose#12756 - Fix: concurrent map writes when pulling by [@skanehira](https://github.com/skanehira) in docker/compose#12752 - Fix support for remote absolute path by [@ndeloof](https://github.com/ndeloof) in docker/compose#12786 - Fix collect image digests for service images built by bake by [@ndeloof](https://github.com/ndeloof) in docker/compose#12784 - Enable services implicitly declared by a service:xx build dependency by [@ndeloof](https://github.com/ndeloof) in docker/compose#12785 - Fix config `--variables` not honoring the `--format` flag by [@alessio-perugini](https://github.com/alessio-perugini) in docker/compose#12809 ##### 🔧 Internal - Remove support of Synchronize File Shares integration with Docker Desktop by [@glours](https://github.com/glours) in docker/compose#12763 - Display proper event message for provider services on up and down by [@glours](https://github.com/glours) in docker/compose#12788 - E2e test for start_interval by [@ndeloof](https://github.com/ndeloof) in docker/compose#12795 - Document behavior on missing extension by [@ndeloof](https://github.com/ndeloof) in docker/compose#12802 ##### ⚙️ Dependencies - Build(deps): bump github.com/docker/cli from `28.1.0+incompatible` to `28.1.1+incompatible` by [@dependabot](https://github.com/dependabot) in docker/compose#12761 - Build(deps): bump github.com/docker/docker from `28.1.0+incompatible` to `28.1.1+incompatible` by [@dependabot](https://github.com/dependabot) in docker/compose#12759 - Build(deps): bump google.golang.org/grpc from `1.71.1` to `1.72.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12760 - Build(deps): bump github.com/containerd/containerd/v2 from `2.0.4` to `2.0.5` by [@dependabot](https://github.com/dependabot) in docker/compose#12758 - Bump compose-go to `v2.6.1` by [@glours](https://github.com/glours) in docker/compose#12766 - Bump compose-go to `v2.6.2` by [@glours](https://github.com/glours) in docker/compose#12810 - Build(deps): bump github.com/moby/buildkit from `0.21.0` to `0.21.1` by [@dependabot](https://github.com/dependabot) in docker/compose#12796 - Build(deps): bump golang.org/x/sync from `0.13.0` to `0.14.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12805 - Build(deps): bump golang.org/x/sys from `0.32.0` to `0.33.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12804 - Build(deps): bump go.uber.org/mock from `0.5.1` to `0.5.2` by [@dependabot](https://github.com/dependabot) in docker/compose#12792 #### New Contributors - [@skanehira](https://github.com/skanehira) made their first contribution in docker/compose#12752 - [@AnvarU](https://github.com/AnvarU) made their first contribution in docker/compose#12769 - [@alessio-perugini](https://github.com/alessio-perugini) made their first contribution in docker/compose#12809 **Full Changelog**: docker/compose@v2.35.1...v2.36.0 ### [`v2.35.1`](https://github.com/docker/compose/releases/tag/v2.35.1) [Compare Source](docker/compose@v2.35.0...v2.35.1) #### What's Changed ##### 🐛 Fixes - Use bind API for bind mounts by [@ndeloof](https://github.com/ndeloof) in docker/compose#12733 - Prefer bind API by [@ndeloof](https://github.com/ndeloof) in docker/compose#12734 ##### 🔧 Internal - CI(bin-image): free disk space by [@crazy-max](https://github.com/crazy-max) in docker/compose#12732 - Fix zizmor security alerts on GHA workflows by [@glours](https://github.com/glours) in docker/compose#12737 - Chore: make function comment match function name by [@dufucun](https://github.com/dufucun) in docker/compose#12748 - Migrate to use github.com/moby/go-archive by [@thaJeztah](https://github.com/thaJeztah) in docker/compose#12716 ##### ⚙️ Dependencies - Build(deps): bump github.com/moby/buildkit from `0.20.1` to `0.20.2` by [@dependabot](https://github.com/dependabot) in docker/compose#12667 - Build(deps): bump google.golang.org/grpc from `1.71.0` to `1.71.1` by [@dependabot](https://github.com/dependabot) in docker/compose#12691 - Build(deps): bump go.uber.org/mock from `0.5.0` to `0.5.1` by [@dependabot](https://github.com/dependabot) in docker/compose#12720 - Build(deps): bump golang.org/x/crypto from `0.32.0` to `0.35.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12745 - Bump buildkit `v0.21.0`, buildx `v0.23.0` by [@thaJeztah](https://github.com/thaJeztah) in docker/compose#12754 - Downgrade go-difflib and go-spew to tagged releases by [@thaJeztah](https://github.com/thaJeztah) in docker/compose#12755 - Bump github.com/docker/docker, github.com/docker/cli `v28.1.0` by [@thaJeztah](https://github.com/thaJeztah) in docker/compose#12738 #### New Contributors - [@dufucun](https://github.com/dufucun) made their first contribution in docker/compose#12748 **Full Changelog**: docker/compose@v2.35.0...v2.35.1 ### [`v2.35.0`](https://github.com/docker/compose/releases/tag/v2.35.0) [Compare Source](docker/compose@v2.34.0...v2.35.0) #### What's Changed 🎉 1st implementation of external services feature to support Docker Model Runner in Compose by [@ndeloof](https://github.com/ndeloof) in docker/compose#12692 ##### ✨ Improvements - Set `$PWD` (may not be supported on Windows) by [@ndeloof](https://github.com/ndeloof) in docker/compose#12643 - Introduce config `--no-env-resolution` by [@ndeloof](https://github.com/ndeloof) in docker/compose#12665 - Introduce `build --print` to dump equivalent bakefile by [@ndeloof](https://github.com/ndeloof) in docker/compose#12675 - Feat(run): Add `--quiet` and `--quiet-build` options for the `run` command by [@idsulik](https://github.com/idsulik) in docker/compose#12685 - Introduce `volume.type=image` by [@ndeloof](https://github.com/ndeloof) in docker/compose#12725 ##### 🐛 Fixes - Fix support for secret set by env inside included file by [@ndeloof](https://github.com/ndeloof) in docker/compose#12635 - Fix edge-case bug checking path prefix in watch for bind mount volumes by [@matiboux](https://github.com/matiboux) in docker/compose#12640 - Run only loads required service env_file and ignores others by [@ndeloof](https://github.com/ndeloof) in docker/compose#12645 - Fixed support for `depends_on.restart` in `up` and `restart` commands by [@ndeloof](https://github.com/ndeloof) in docker/compose#12649 - Bake parses "${}" in DockerfileInline as a variable by [@ndeloof](https://github.com/ndeloof) in docker/compose#12664 - Fix(secrets): Reverted secrets file mode 440 -> 444 by [@idsulik](https://github.com/idsulik) in docker/compose#12666 - Fix scale completion by [@ndeloof](https://github.com/ndeloof) in docker/compose#12672 - Fix: replace `docker-compose.yml` with `compose.yaml` by [@k-kbk](https://github.com/k-kbk) in docker/compose#12680 - Include implicit build dependencies in build command by [@ndeloof](https://github.com/ndeloof) in docker/compose#12683 - Capture git fetch output when debug output is enabled by [@ndeloof](https://github.com/ndeloof) in docker/compose#12719 - Mount API is not strictly equivalent to bind by [@ndeloof](https://github.com/ndeloof) in docker/compose#12722 ##### 🔧 Internal - Test commandName subcommand order by [@maxproske](https://github.com/maxproske) in docker/compose#12535 - Set watch option --prune=true as default by [@remcokranenburg](https://github.com/remcokranenburg) in docker/compose#12650 - Plugin Docker Desktop Model Runner check by [@glours](https://github.com/glours) in docker/compose#12718 - pkg/compose: implement Export using atomicwriter by [@thaJeztah](https://github.com/thaJeztah) in docker/compose#12715 - Style: refactor Desktop client for readability and maintainability by [@Saracomethstein](https://github.com/Saracomethstein) in docker/compose#12723 ##### ⚙️ Dependencies - Build(deps): bump github.com/docker/buildx from `0.21.2` to `0.21.3` by [@dependabot](https://github.com/dependabot) in docker/compose#12646 - Build(deps): bump github.com/containerd/containerd/v2 from `2.0.3` to `2.0.4` by [@dependabot](https://github.com/dependabot) in docker/compose#12647 - Bump docker & cli `v28.0.4` and buildx `v0.22.0` by [@ndeloof](https://github.com/ndeloof) in docker/compose#12674 - Bump golangci-lint to version `v2.0.2` by [@glours](https://github.com/glours) in docker/compose#12689 - Bump golang to `1.23.8` by [@glours](https://github.com/glours) in docker/compose#12698 - Update secret detector to fix vulnerability https://github.com/golang… by [@sigi-glovebox](https://github.com/sigi-glovebox) in docker/compose#12707 - Build(deps): bump golang.org/x/sys from `0.31.0` to `0.32.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12713 - Build(deps): bump golang.org/x/sync from `0.12.0` to `0.13.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12712 - Build(deps): bump github.com/compose-spec/compose-go/v2 from `2.5.1-0.20250409070949-8e1a035095ca` to `2.6.0` by [@dependabot](https://github.com/dependabot) in docker/compose#12729 #### New Contributors - [@matiboux](https://github.com/matiboux) made their first contribution in docker/compose#12640 - [@k-kbk](https://github.com/k-kbk) made their first contribution in docker/compose#12680 - [@sigi-glovebox](https://github.com/sigi-glovebox) made their first contribution in docker/compose#12707 - [@Saracomethstein](https://github.com/Saracomethstein) made their first contribution in docker/compose#12723 **Full Changelog**: docker/compose@v2.34.0...v2.35.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

alessio-perugini requested a review from a team as a code owner May 6, 2025 17:20

alessio-perugini requested review from ndeloof and glours May 6, 2025 17:20

alessio-perugini force-pushed the variables-follow-the-format-setting branch from 4debc20 to 14bc441 Compare May 6, 2025 17:25

e2e: add tests

abecf66

Signed-off-by: Alessio Perugini <alessio@perugini.xyz>

alessio-perugini force-pushed the variables-follow-the-format-setting branch from 245d340 to abecf66 Compare May 6, 2025 17:43

ndeloof approved these changes May 6, 2025

View reviewed changes

docs: regenerate

7558912

Signed-off-by: Alessio Perugini <alessio@perugini.xyz>

ndeloof merged commit 4bf18d2 into docker:main May 6, 2025
28 checks passed

BrewTestBot mentioned this pull request May 7, 2025

docker-compose 2.36.0 Homebrew/homebrew-core#222724

Merged

rancherbot mentioned this pull request May 8, 2025

rddepman: bump dockerCompose from 2.35.1 to 2.36.0 rancher-sandbox/rancher-desktop#8609

Merged

This was referenced May 13, 2025

- mook-as/rd#307

Closed

rddepman: bump dockerCompose from 2.35.1 to 2.36.0 mook-as/rd#315

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix config --variables not honoring the --format flag #12809

Fix config --variables not honoring the --format flag #12809

Uh oh!

alessio-perugini commented May 6, 2025 •

edited

Loading

Uh oh!

ndeloof commented May 6, 2025

Uh oh!

alessio-perugini commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

Fix config --variables not honoring the --format flag #12809

Fix config --variables not honoring the --format flag #12809

Uh oh!

Conversation

alessio-perugini commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ndeloof commented May 6, 2025

Uh oh!

alessio-perugini commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

alessio-perugini commented May 6, 2025 •

edited

Loading