Remzona54/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2026-08-04 06:38:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Update dry-run documentation

Browse source 
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
This commit is contained in:
Guillaume Lours 2023-05-05 12:43:27 +02:00 • committed by Nicolas De loof
parent e8caad1903
commit 312f0d1d61
58 changed files with 375 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/reference/compose.md
View file

@ -175,7 +175,7 @@ containers for the project.
### Use Dry Run mode to test your command
Use `--dry-run` flag to test a command without changing your application stack state.
Dry Run mode will show you all the steps Compose will apply by executing the command, for example:
Dry Run mode shows you all the steps Compose applies when executing a command, for example:
```console
$ docker compose --dry-run up --build -d
[+] Pulling 1/1
@ -192,10 +192,10 @@ $ docker compose --dry-run up --build -d
✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Started 0.0s
✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Started Started
```
You could see that the first step will be to pull the image defined by `db` service, then build the `backend` service.
After that, containers will be created, the `db` service started and the `backend` and `proxy` will wait until `db` service is healthy to start.
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.
The Dry Run mode is not supported by all commands, especially by the command which doesn't change the state of a Compose stack
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
such as `ps`, `ls`, `logs` for example.
Here the list of commands supporting `--dry-run` flag: