From d13aead73b832fdd864130e1c36efdf0de544ce8 Mon Sep 17 00:00:00 2001 From: Guillaume Lours <705411+glours@users.noreply.github.com> Date: Thu, 20 Jun 2024 13:00:59 +0200 Subject: [PATCH] update Compose v2.27.1 and v2.27.2 release notes (#20266) * update Compose v2.27.1 and v2.27.2 release notes Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> * Apply suggestions from code review --------- Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> --- .../compose/v2/docs/reference/compose.md | 3 + .../v2/docs/reference/compose_config.md | 1 + .../compose/v2/docs/reference/compose_up.md | 59 ++++++++++--------- .../v2/docs/reference/docker_compose.yaml | 3 + .../docs/reference/docker_compose_config.yaml | 10 ++++ .../v2/docs/reference/docker_compose_up.yaml | 4 +- _vendor/modules.txt | 2 +- content/compose/release-notes.md | 36 +++++++++++ go.mod | 4 +- go.sum | 2 + hugo.yaml | 2 +- 11 files changed, 91 insertions(+), 35 deletions(-) diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md index 09a4c69da9..7770f785a0 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md @@ -177,6 +177,9 @@ If flags are explicitly set on the command line, the associated environment vari Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. +Setting the `COMPOSE_MENU` environment variable to `false` disables the helper menu when running `docker compose up` +in attached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu. + ### Use Dry Run mode to test your command Use `--dry-run` flag to test a command without changing your application stack state. diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md index e38eb5c654..8b9671236f 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md @@ -12,6 +12,7 @@ Parse, resolve and render compose file in canonical format | Name | Type | Default | Description | |:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | +| `--environment` | | | Print environment used for interpolation. | | `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | | `--hash` | `string` | | Print the service config hash, one per line. | | `--images` | | | Print the image names, one per line. | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md index 3829963953..dbe00a82f0 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md @@ -5,35 +5,36 @@ Create and start containers ### Options -| Name | Type | Default | Description | -|:-------------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------------| -| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | -| `--abort-on-container-failure` | | | Stops all containers if any container exited with failure. Incompatible with -d | -| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | -| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | -| `--attach-dependencies` | | | Automatically attach to log output of dependent services | -| `--build` | | | Build images before starting containers | -| `-d`, `--detach` | | | Detached mode: Run containers in the background | -| `--dry-run` | | | Execute command in dry run mode | -| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | -| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed | -| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services | -| `--no-build` | | | Don't build an image, even if it's policy | -| `--no-color` | | | Produce monochrome output | -| `--no-deps` | | | Don't start linked services | -| `--no-log-prefix` | | | Don't print prefix in logs | -| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | | | Don't start the services after creating them | -| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | -| `--quiet-pull` | | | Pull without printing progress information | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | -| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | -| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | -| `--timestamps` | | | Show timestamps | -| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | -| `-w`, `--watch` | | | Watch source code and rebuild/refresh containers when files are updated. | +| Name | Type | Default | Description | +|:-------------------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------| +| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | +| `--abort-on-container-failure` | | | Stops all containers if any container exited with failure. Incompatible with -d | +| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | +| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | +| `--attach-dependencies` | | | Automatically attach to log output of dependent services | +| `--build` | | | Build images before starting containers | +| `-d`, `--detach` | | | Detached mode: Run containers in the background | +| `--dry-run` | | | Execute command in dry run mode | +| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | +| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed | +| `--menu` | | | Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var. | +| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services | +| `--no-build` | | | Don't build an image, even if it's policy | +| `--no-color` | | | Produce monochrome output | +| `--no-deps` | | | Don't start linked services | +| `--no-log-prefix` | | | Don't print prefix in logs | +| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | +| `--no-start` | | | Don't start the services after creating them | +| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | +| `--quiet-pull` | | | Pull without printing progress information | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | +| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | +| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | +| `--timestamps` | | | Show timestamps | +| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | +| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | +| `-w`, `--watch` | | | Watch source code and rebuild/refresh containers when files are updated. | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml index f725467df8..64e5b7a1d2 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml @@ -118,6 +118,9 @@ long: |- Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. + Setting the `COMPOSE_MENU` environment variable to `false` disables the helper menu when running `docker compose up` + in attached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu. + ### Use Dry Run mode to test your command Use `--dry-run` flag to test a command without changing your application stack state. diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml index 68a7b8994e..8073d85ab6 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml @@ -9,6 +9,16 @@ usage: docker compose config [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml options: + - option: environment + value_type: bool + default_value: "false" + description: Print environment used for interpolation. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: format value_type: string default_value: yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml index 760a32da33..4c895f6a65 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml @@ -123,9 +123,9 @@ options: value_type: bool default_value: "false" description: | - Enable interactive shortcuts when running attached (Experimental). Incompatible with --detach. + Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var. deprecated: false - hidden: true + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 794784560a..c6097bb1e3 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -2,5 +2,5 @@ # github.com/moby/buildkit v0.14.1 # github.com/docker/buildx v0.15.1 # github.com/docker/cli v26.1.4+incompatible -# github.com/docker/compose/v2 v2.27.0 +# github.com/docker/compose/v2 v2.27.2 # github.com/docker/scout-cli v1.9.3 diff --git a/content/compose/release-notes.md b/content/compose/release-notes.md index f34521a672..ab534bd16c 100644 --- a/content/compose/release-notes.md +++ b/content/compose/release-notes.md @@ -10,6 +10,42 @@ aliases: For more detailed information, see the [release notes in the Compose repo](https://github.com/docker/compose/releases/). +## 2.27.2 + +{{< release-date date="2024-06-20" >}} + +### Update + +- Dependencies upgrade: bump golang to 1.21.11 +- Dependencies upgrade: bump docker engine and cli to v26.1.4 +- Dependencies upgrade: bump buildx to 0.15.0 +- Dependencies upgrade: bump buildkit to 0.14.0 +- Dependencies upgrade: bump containerd to 1.7.18 + +### Bug fixes and enhancements + +- Added an `--environment` flag to the `config` command +- Fixed a bug which caused the `watch` process to hang when used as flag with the `up` command +- Fixed usage of `COMPOSE_PROFILES` in `.env` file + +## 2.27.1 + +{{< release-date date="2024-05-24" >}} + +### Update + +- Dependencies upgrade: bump compose-go to v2.1.1 +- Dependencies upgrade: bump docker engine and cli to v26.1.3 +- Dependencies upgrade: bump buildx to 0.14.1 +- Dependencies upgrade: bump containerd to 1.7.17 + +### Bug fixes and enhancements + +- Added a navigation menu in the CLI where you can open your Compose file in Docker Desktop +- Added documentation for `--menu` flag in `docker compose up` +- Fixed a bug with `--resolve-image-digests` used with `--no-interpolate` +- You can now use a local `.env` file to override `COMPOSE_*` environment variables + ## 2.27.0 {{< release-date date="2024-04-24" >}} diff --git a/go.mod b/go.mod index 088753b1ce..a1d920557e 100644 --- a/go.mod +++ b/go.mod @@ -7,7 +7,7 @@ toolchain go1.21.1 require ( github.com/docker/buildx v0.15.1 // indirect github.com/docker/cli v26.1.4+incompatible // indirect - github.com/docker/compose/v2 v2.27.0 // indirect + github.com/docker/compose/v2 v2.27.2 // indirect github.com/docker/scout-cli v1.9.3 // indirect github.com/moby/buildkit v0.14.1 // indirect github.com/moby/moby v26.1.2+incompatible // indirect @@ -16,7 +16,7 @@ require ( replace ( github.com/docker/buildx => github.com/docker/buildx v0.15.1 github.com/docker/cli => github.com/docker/cli v26.1.3-0.20240513184838-60f2d38d5341+incompatible - github.com/docker/compose/v2 => github.com/docker/compose/v2 v2.27.0 + github.com/docker/compose/v2 => github.com/docker/compose/v2 v2.27.2 github.com/docker/scout-cli => github.com/docker/scout-cli v1.9.3 github.com/moby/buildkit => github.com/moby/buildkit v0.14.0-rc2.0.20240611065153-eed17a45c62b github.com/moby/moby => github.com/moby/moby v26.1.2+incompatible diff --git a/go.sum b/go.sum index a3b720b5e4..802ff4d3ba 100644 --- a/go.sum +++ b/go.sum @@ -138,6 +138,8 @@ github.com/docker/compose/v2 v2.26.1 h1:27fAR5jVzNUYwY/9ppIjrPqGYLW5HtOTq2aYGBMC github.com/docker/compose/v2 v2.26.1/go.mod h1:5iVCMlr18ab0NlMxIPdtTgThTkzb34Z/zj15N7KSW+s= github.com/docker/compose/v2 v2.27.0 h1:FKyClQdErCxUZULC2zo6Jn5ve+epFPe/Y0HaxjmUzNg= github.com/docker/compose/v2 v2.27.0/go.mod h1:uaqwmY6haO8wXWHk+LAsqqDapX6boH4izRKqj/E7+Bo= +github.com/docker/compose/v2 v2.27.2 h1:8uvz019AZIPmw8+rnLBubAuyt9SEoU/pyCcAJPXMq0A= +github.com/docker/compose/v2 v2.27.2/go.mod h1:c6QJ/VVZrzVu97Ur1jylFLivvTkFdef1rSzmnQAO3DA= github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.3+incompatible h1:AtKxIZ36LoNK51+Z6RpzLpddBirtxJnzDrHLEKxTAYk= diff --git a/hugo.yaml b/hugo.yaml index 93a76db5a3..3a5ce1c422 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -98,7 +98,7 @@ params: latest_engine_api_version: "1.45" docker_ce_version: "26.1.4" - compose_version: "v2.27.1" + compose_version: "v2.27.2" compose_file_v3: "3.8" compose_file_v2: "2.4" buildkit_version: "0.13.1"