Merge pull request #491 from itk-dev/feature/docker-compose-light

Optimized development setup

Author: rimi-itk

CHANGELOG.md

@@ -6,6 +6,9 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+* [PR-491](https://github.com/itk-dev/hoeringsportal/pull/491)
+  Optimized development setup
+
 ## [4.8.7] - 2025-04-04
 
 * [PR-488](https://github.com/itk-dev/hoeringsportal/pull/488)

Taskfile.yml

@@ -7,6 +7,7 @@ vars:
   # https://taskfile.dev/reference/templating/
   BASE_URL: '{{.TASK_BASE_URL | default .COMPOSE_SERVER_DOMAIN | default .COMPOSE_DOMAIN | default "https://hoeringsportal.local.itkdev.dk"}}'
   DOCKER_COMPOSE: '{{.TASK_DOCKER_COMPOSE | default "docker compose"}}'
+  DOCKER_COMPOSE_PROFILES: '{{.TASK_DOCKER_COMPOSE_PROFILES | default ""}}'
   COMPOSER_INSTALL_ARGUMENTS: '{{.TASK_COMPOSER_INSTALL_ARGUMENTS | default ""}}'
 
   PRETIX_URL: '{{.TASK_PRETIX_URL | default "http://pretix.hoeringsportal.local.itkdev.dk"}}'
@@ -64,15 +65,23 @@ tasks:
 
   assets-build:
     cmds:
-      - '{{.DOCKER_COMPOSE}} run --rm node npm install --prefix web/themes/custom/hoeringsportal'
-      - '{{.DOCKER_COMPOSE}} run --rm node npm run build --prefix web/themes/custom/hoeringsportal'
+      - |
+        if [[ -z "{{.SKIP_BUILD}}" ]]; then
+          echo {{.DOCKER_COMPOSE}} run --rm node npm install --prefix web/themes/custom/hoeringsportal
+          echo {{.DOCKER_COMPOSE}} run --rm node npm run build --prefix web/themes/custom/hoeringsportal
+        fi
+    vars:
+      SKIP_BUILD: '{{.ASSETS_SKIP_BUILD | default .TASK_ASSETS_SKIP_BUILD}}'
+
   compose:
     cmds:
-      - '{{.DOCKER_COMPOSE}} --profile pretix {{.CLI_ARGS}}'
+      - '{{.DOCKER_COMPOSE}} {{if .DOCKER_COMPOSE_PROFILES}}--profile {{.DOCKER_COMPOSE_PROFILES | splitList "," |join " --profile " }}{{end}} {{.CLI_ARGS}}'
+    vars:
+      DOCKER_COMPOSE_PROFILES: '{{.PROFILES | default .DOCKER_COMPOSE_PROFILES}}'
 
   compose-up:
     cmds:
-      - task compose -- up --detach --remove-orphans --wait
+      - task compose -- up --detach --remove-orphans {{if .COMPOSE_UP_WAIT}}--wait{{end}}
     silent: true
 
   composer:
@@ -225,9 +234,12 @@ tasks:
   fixtures:load:
     prompt: "This will reset your content. Continue?"
     cmds:
-     - task drush -- --yes pm:enable hoeringsportal_base_fixtures $(find web/modules/custom -type f -name 'hoeringsportal_*_fixtures.info.yml' -exec basename -s .info.yml {} \;)
-     - task drush -- --yes content-fixtures:load
-     - task drush -- --yes pm:uninstall content_fixtures
+      # We need the pretix service to load public meeting fixtures.
+      - PROFILES=pretix COMPOSE_UP_WAIT=true task compose-up
+      - task drush -- --yes pm:enable hoeringsportal_base_fixtures $(find web/modules/custom -type f -name 'hoeringsportal_*_fixtures.info.yml' -exec basename -s .info.yml {} \;)
+      - task drush -- --yes content-fixtures:load
+      - task drush -- --yes pm:uninstall content_fixtures
+      - task compose-up
     silent: true
 
   translations:import:

docker-compose.override.yml

@@ -19,6 +19,8 @@ services:
 
   clamav:
     image: clamav/clamav:1.2
+    profiles:
+      - clamav
     networks:
       - app
     ports:

documentation/localDevelopment.md

@@ -1,7 +1,47 @@
 # Hoeringsportal local development
 
+We use [Task](https://taskfile.dev/) in this project. Run
+
+``` shell
+task site-update
+```
+
+to update the site (previously installed by running `task site-install`).
+
+For performance reasons, we start only the basic docker services by default, but you can set
+`TASK_DOCKER_COMPOSE_PROFILES` in `.env.local` to start more docker services based on
+[profiles](https://docs.docker.com/compose/how-tos/profiles/), e.g.
+
+``` shell
+# .env.local
+
+# Always start pretix and friends.
+TASK_DOCKER_COMPOSE_PROFILES=pretix
+```
+
+You can also set 'PROFILES` when running the `compose` task, e.g.
+
+``` shell
+PROFILES=pretix task compose -- up --detach
+```
+
+> [!TIP]
+> Run `git grep -A2 'profiles:' '*.y*ml'` to get a crude list of all profiles in the project.
+
+When running `task site-update`, theme assets are built and this may take quite some time. To skip building assets, you
+can run `ASSETS_SKIP_BUILD=1 task site-update` or set `TASK_ASSETS_SKIP_BUILD` in `.env.local`, e.g.
+
+``` shell
+# .env.local
+
+TASK_ASSETS_SKIP_BUILD=1
+```
+
 ## Local setup
 
+> [!CAUTION]
+> The following should be updated and rewritten to reflect the actual development workflow.
+
 Create the file `web/sites/default/settings.local.php` and add:
 
 ```php