docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Watch sync and restart action (#18463) 

* add sync+restart definition to watch documentation

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

* align watch path, relative to project dir and not build context, with specification definition

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

* add prerequistes for compose watch feature

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

* Update content/compose/file-watch.md

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
This commit is contained in:
Guillaume Lours 2023-10-19 10:01:03 +02:00 committed by GitHub
parent 0aee3ebe1d
commit 743730eff1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
content/compose/file-watch.md
View File

@ -13,7 +13,7 @@ Use `watch` to automatically update and preview your running Compose services as
For many projects, this allows for a hands-off development workflow once Compose is running, as services automatically update themselves when you save your work. For many projects, this allows for a hands-off development workflow once Compose is running, as services automatically update themselves when you save your work.
`watch` adheres to the following file path rules: `watch` adheres to the following file path rules:
* All paths are relative to the build context * All paths are relative to the project directory
* Directories are watched recursively * Directories are watched recursively
* Glob patterns aren't supported * Glob patterns aren't supported
* Rules from `.dockerignore` apply * Rules from `.dockerignore` apply
@ -45,6 +45,14 @@ the `action`, additional fields might be accepted or required.
Watch mode can be used with many different languages and frameworks. Watch mode can be used with many different languages and frameworks.
The specific paths and rules will vary project to project, but the concepts remain the same. The specific paths and rules will vary project to project, but the concepts remain the same.
### Prerequisites
In order to work properly, `watch` relies on common executables. Make sure your service image contains the following binaries:
* stat
* mkdir
* rmdir
* tar
### `action` ### `action`
#### Sync #### Sync
@ -64,6 +72,13 @@ The behavior is the same as running `docker compose up --build <svc>`.
Rebuild is ideal for compiled languages or as fallbacks for modifications to particular files that require a full Rebuild is ideal for compiled languages or as fallbacks for modifications to particular files that require a full
image rebuild (e.g. `package.json`). image rebuild (e.g. `package.json`).
#### Sync + Restart
If `action` is set to `sync+restart`, Compose synchronizes your changes with the service containers and restarts it.
`sync+restart` is ideal when config file changes, and you don't need to rebuild the image but just restart the main process of the service containers.
It will work well when you update a database configuration or your `nginx.conf` file for example
>**Tip** >**Tip**
> >
> Optimize your `Dockerfile` for speedy > Optimize your `Dockerfile` for speedy