Refine the run-docker-dev to watch changes and restart worker service (…

…#1483)

Signed-off-by: tdruez <[email protected]>

Makefile

@@ -123,7 +123,7 @@ run:
 
 run-docker-dev:
 	@echo "-> Run the Docker compose services in dev mode (hot reload on code changes)"
-	docker compose -f docker-compose.yml -f docker-compose.dev.yml up
+	docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build --watch
 
 test:
 	@echo "-> Run the test suite"

docker-compose.dev.yml

@@ -1,5 +1,6 @@
-# Mount the local scanpipe/ directory in the containers
+# Dev mode, https://docs.docker.com/compose/how-tos/file-watch/
 
+# Mount the local scanpipe/ directory in the containers
 # This can be used to refresh fixtures from the docker container:
 # $ docker compose -f docker-compose.yml -f docker-compose.dev.yml up
 # $ docker compose -f docker-compose.yml -f docker-compose.dev.yml run --rm web bash
@@ -15,5 +16,8 @@ services:
   worker:
     env_file:
       - docker.dev.env
-    volumes:
-      - ./scanpipe:/opt/scancodeio/scanpipe
+    develop:
+      watch:
+        - action: sync+restart
+          path: ./scanpipe
+          target: /opt/scancodeio/scanpipe

docs/installation.rst

@@ -229,7 +229,12 @@ Supported Platforms
     #. **macOS** 10.14 and up
 
 .. warning::
-     On **Windows** ScanCode.io can **only** be :ref:`run_with_docker`.
+    On **Windows** ScanCode.io can **only** be :ref:`run_with_docker`.
+    Alternatively, you can run a local checkout with the Docker compose stack using the
+    dedicated command::
+
+        make run-docker-dev
+
 
 Pre-installation Checklist
 ^^^^^^^^^^^^^^^^^^^^^^^^^^