Docs: --wait Wait for services to be running|healthy. Implies detached mode. Which is it?
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6.1k
- Forks
- 2.2k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 43
Description
Description
docker compose up --help has this to say about the --wait flag:
--wait Wait for services to be running|healthy. Implies detached mode.
But which is it, running? health? either running or healthy? running in some cases and healthy in other cases?
I started digging into this when our CI didn't do what we expected to. CI will get fixed, but I'd like to be able to understand the flag from the help text 🙏🏻
Reproduce
docker compose up --help
Expected behavior
No response
docker version
Docker Compose version v2.12.2
Docker version 20.10.21, build baeda1f
docker info
n/a
Additional Info
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running docker compose up --help and trace the --wait help text to the Docker Compose implementation or documentation used by this CLI. Confirm whether it waits for services to be running, healthy, or either, then update the help wording so the behavior is unambiguous and verify the command output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100