Update Compose reference API to v2.19.0 (#17583)

Signed-off-by: GitHub <noreply@github.com>
Co-authored-by: glours <glours@users.noreply.github.com>
This commit is contained in:
docker-tools-robot 2023-06-21 14:37:38 +02:00 committed by GitHub
parent 9050e24727
commit 79c0ddc662
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 39 additions and 31 deletions

View File

@ -45,7 +45,7 @@ exclude:
latest_engine_api_version: "1.43" latest_engine_api_version: "1.43"
docker_ce_version: "24.0.0" docker_ce_version: "24.0.0"
compose_v1_version: "1.29.2" compose_v1_version: "1.29.2"
compose_version: "v2.18.1" compose_version: "v2.19.0"
compose_file_v3: "3.8" compose_file_v3: "3.8"
compose_file_v2: "2.4" compose_file_v2: "2.4"
machine_version: "0.16.0" machine_version: "0.16.0"

View File

@ -118,7 +118,6 @@ long: |-
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
containers for the project. containers for the project.
### Use Dry Run mode to test your command ### Use Dry Run mode to test your command
Use `--dry-run` flag to test a command without changing your application stack state. Use `--dry-run` flag to test a command without changing your application stack state.
@ -142,26 +141,7 @@ long: |-
From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service. From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service.
Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting. Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting.
Dry Run mode does not currently work with all commands. In particular, you cannot use Dry Run mode with a command that doesn't change the state of a Compose stack Dry Run mode works with almost all commands. You cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example.
such as `ps`, `ls`, `logs` for example.
Here the list of commands supporting `--dry-run` flag:
* build
* cp
* create
* down
* exec
* kill
* pause
* pull
* push
* remove
* restart
* run
* start
* stop
* unpause
* up
usage: docker compose usage: docker compose
pname: docker pname: docker
plink: docker.yaml plink: docker.yaml
@ -300,6 +280,16 @@ options:
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: progress
value_type: string
default_value: auto
description: Set type of progress output (auto, tty, plain, quiet)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: project-directory - option: project-directory
value_type: string value_type: string
description: |- description: |-

View File

@ -90,9 +90,9 @@ options:
- option: progress - option: progress
value_type: string value_type: string
default_value: auto default_value: auto
description: Set type of progress output (auto, tty, plain, quiet) description: Set type of ui output (auto, tty, plain, quiet)
deprecated: false deprecated: false
hidden: false hidden: true
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false

View File

@ -14,7 +14,7 @@ long: |-
Anonymous volumes are not removed by default. However, as they dont have a stable name, they will not be automatically Anonymous volumes are not removed by default. However, as they dont have a stable name, they will not be automatically
mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
named volumes. named volumes.
usage: docker compose down [OPTIONS] usage: docker compose down [OPTIONS] [SERVICES]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
@ -41,7 +41,7 @@ options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "0"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
hidden: false hidden: false
@ -54,7 +54,7 @@ options:
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers.
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false

View File

@ -28,7 +28,7 @@ options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "0"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
hidden: false hidden: false

View File

@ -3,7 +3,7 @@ short: Run a one-off command on a service.
long: |- long: |-
Runs a one-time command against a service. Runs a one-time command against a service.
The following command starts the `web` service and runs `bash` as its command: the following command starts the `web` service and runs `bash` as its command:
```console ```console
$ docker compose run web bash $ docker compose run web bash
@ -68,6 +68,24 @@ options:
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: cap-add
value_type: list
description: Add Linux capabilities
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop
value_type: list
description: Drop Linux capabilities
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach - option: detach
shorthand: d shorthand: d
value_type: bool value_type: bool

View File

@ -9,7 +9,7 @@ options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "0"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
hidden: false hidden: false

View File

@ -234,7 +234,7 @@ options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "0"
description: | description: |
Use this timeout in seconds for container shutdown when attached or when containers are already running. Use this timeout in seconds for container shutdown when attached or when containers are already running.
deprecated: false deprecated: false