Skip to content

recommend use of up --watch and document watch command as an alternative #19895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 26, 2024
Merged

recommend use of up --watch and document watch command as an alternative #19895

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a14f4e7
recommend use of up --watch and document watch command as an alternative
ndeloof Apr 26, 2024
1e92594
Apply suggestions from code review
aevesdocker Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions content/compose/file-watch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ In order to work properly, `watch` relies on common executables. Make sure your
* stat
* mkdir
* rmdir
* tar

`watch` also requires that the container's `USER` can write to the target path so it can update files. A common pattern is for
initial content to be copied into the container using the `COPY` instruction in a Dockerfile. To ensure such files are owned
Expand Down Expand Up @@ -142,7 +141,7 @@ services:
path: package.json
```

In this example, when running `docker compose watch`, a container for the `web` service is launched using an image built from the `Dockerfile` in the project's root.
In this example, when running `docker compose up --watch`, a container for the `web` service is launched using an image built from the `Dockerfile` in the project's root.
The `web` service runs `npm start` for its command, which then launches a development version of the application with Hot Module Reload enabled in the bundler (Webpack, Vite, Turbopack, etc).

After the service is up, the watch mode starts monitoring the target directories and files.
Expand All @@ -159,7 +158,7 @@ This pattern can be followed for many languages and frameworks, such as Python w
## Use `watch`

1. Add `watch` sections to one or more services in `compose.yaml`.
2. Run `docker compose watch` to build and launch a Compose project and start the file watch mode.
2. Run `docker compose up --watch` to build and launch a Compose project and start the file watch mode.
3. Edit service source files using your preferred IDE or editor.

> **Looking for a sample project to test things out?**
Expand All @@ -169,6 +168,14 @@ This pattern can be followed for many languages and frameworks, such as Python w
> for a demonstration of Compose `watch`.
{ .tip }


> **Tip**
>
> Watch can also be used with the dedicated `docker compose watch` command if you don't want to
> get the application logs mixed with the (re)build logs and filesystem sync events.
{ .tip }


## Feedback

We are actively looking for feedback on this feature. Give feedback or report any bugs you may find in the [Compose Specification repository](https://github.com/compose-spec/compose-spec/pull/253).
Expand Down