Make compose watch a separate command

Author: medihack

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
       - name: Start Docker containers
-        run: uv run ./cli.py compose-up -- --no-build
+        run: uv run ./cli.py compose-up -- --detach --no-build
       - name: Run linting
         # https://github.com/actions/runner/issues/241#issuecomment-745902718
         shell: 'script -q -e -c "bash {0}"'

adit_radis_shared/cli/commands.py

@@ -27,6 +27,29 @@ def compose_build(profile: list[str], extra_args: list[str], **kwargs):
     print("Build finished.")
 
 
+def compose_watch(profile: list[str], extra_args: list[str], **kwargs):
+    helper = CommandHelper()
+    helper.prepare_environment()
+
+    if helper.is_production():
+        sys.exit(
+            "Starting containers with compose-watch can only be used in development. "
+            "Check ENVIRONMENT setting in .env file."
+        )
+
+    cmd = f"{helper.build_compose_cmd(profile, watch_mode=True)} up --watch"
+    if extra_args:
+        cmd += " " + " ".join(extra_args)
+
+    helper.execute_cmd(
+        cmd,
+        env={
+            "COMPOSE_BAKE": "true",
+            "PROJECT_VERSION": helper.get_local_project_version(),
+        },
+    )
+
+
 def compose_up(profile: list[str], extra_args: list[str], **kwargs):
     helper = CommandHelper()
     helper.prepare_environment()
@@ -37,7 +60,7 @@ def compose_up(profile: list[str], extra_args: list[str], **kwargs):
             "Check ENVIRONMENT setting in .env file."
         )
 
-    cmd = f"{helper.build_compose_cmd(profile)} up --watch"
+    cmd = f"{helper.build_compose_cmd(profile)} up"
     if extra_args:
         cmd += " " + " ".join(extra_args)
 

adit_radis_shared/cli/helper.py

@@ -135,6 +135,9 @@ def get_compose_env_file(self):
             return self.root_path / "docker-compose.prod.yml"
         return self.root_path / "docker-compose.dev.yml"
 
+    def get_compose_watch_file(self):
+        return self.root_path / "docker-compose.watch.yml"
+
     def get_stack_name(self) -> str:
         config = self.load_config_from_env_file()
         if stack_name := config.get("STACK_NAME", ""):
@@ -144,10 +147,12 @@ def get_stack_name(self) -> str:
             return f"{self.project_id}_prod"
         return f"{self.project_id}_dev"
 
-    def build_compose_cmd(self, profiles: list[str] | None = None):
+    def build_compose_cmd(self, profiles: list[str] | None = None, watch_mode: bool = False) -> str:
         cmd = "docker compose"
         cmd += f" -f {self.get_compose_base_file()}"
         cmd += f" -f {self.get_compose_env_file()}"
+        if watch_mode:
+            cmd += f" -f {self.get_compose_watch_file()}"
         cmd += f" -p {self.get_stack_name()}"
 
         if profiles:

adit_radis_shared/cli/parsers.py

@@ -13,6 +13,15 @@ def register_compose_build(subparsers: argparse._SubParsersAction, func: Callabl
     parser.set_defaults(func=func or commands.compose_build)
 
 
+def register_compose_watch(subparsers: argparse._SubParsersAction, func: Callable | None = None):
+    info = "Start stack with docker compose and watch for changes"
+    parser = subparsers.add_parser("compose-watch", help=info, description=info)
+    parser.add_argument(
+        "--profile", action="append", default=[], help="Docker compose profile(s) to use"
+    )
+    parser.set_defaults(func=func or commands.compose_watch)
+
+
 def register_compose_up(subparsers: argparse._SubParsersAction, func: Callable | None = None):
     info = "Start stack with docker compose"
     parser = subparsers.add_parser("compose-up", help=info, description=info)

cli.py

@@ -44,6 +44,7 @@ def copy_file(file: str, filename: str | None = None):
     subparsers = root_parser.add_subparsers(dest="command")
 
     parsers.register_compose_build(subparsers)
+    parsers.register_compose_watch(subparsers)
     parsers.register_compose_up(subparsers)
     parsers.register_compose_down(subparsers)
     parsers.register_db_backup(subparsers)

docker-compose.base.yml

@@ -4,7 +4,6 @@ x-app: &default-app
   depends_on:
     - postgres
   environment:
-    BACKUP_DIR: ${BACKUP_DIR:?}
     DATABASE_URL: postgres://postgres:postgres@postgres.local:5432/postgres
     DBBACKUP_STORAGE_LOCATION: /backups
     DJANGO_ADMIN_EMAIL: ${DJANGO_ADMIN_EMAIL:?}

docker-compose.dev.yml

@@ -2,21 +2,15 @@ x-app: &default-app
   image: example_project_dev:latest
   build:
     target: development
+  volumes:
+    - .:/app
+    - /app/.venv
   environment:
     DJANGO_INTERNAL_IPS: ${DJANGO_INTERNAL_IPS:?}
     DJANGO_SETTINGS_MODULE: example_project.settings.development
     FORCE_DEBUG_TOOLBAR: ${FORCE_DEBUG_TOOLBAR:-true}
     REMOTE_DEBUGGING_ENABLED: ${REMOTE_DEBUGGING_ENABLED:-false}
     REMOTE_DEBUGGING_PORT: ${REMOTE_DEBUGGING_PORT:-5678}
-  develop:
-    watch:
-      - action: sync
-        path: .
-        target: /app
-        ignore:
-          - .venv/
-      - action: rebuild
-        path: ./pyproject.toml
 
 services:
   init:

docker-compose.watch.yml

@@ -0,0 +1,19 @@
+x-app: &default-app
+  volumes: !override
+    - ${BACKUP_DIR:?}:/backups
+  develop:
+    watch:
+      - action: sync
+        path: .
+        target: /app
+        ignore:
+          - .venv/
+      - action: rebuild
+        path: ./pyproject.toml
+
+services:
+  web:
+    <<: *default-app
+
+  worker:
+    <<: *default-app