🔧(project) change env.d system by using local files

We had lot of problems with the previous env.d system.
Users were often confused by the need to change
the env.d files manually, leading to issues
when using the project locally.
This commit introduces a new system that uses
.env.local files, which are automatically created
and can be modified by users without affecting
the original env.d files. This should simplify
the development process and reduce confusion by
removing the need to manually edit env.d files.

Author: AntoLC

.github/workflows/impress-frontend.yml

@@ -80,7 +80,7 @@ jobs:
           fail-on-cache-miss: true
 
       - name: Set e2e env variables
-        run: cat env.d/development/common.e2e.dist >> env.d/development/common.dist
+        run: cat env.d/development/common.e2e >> env.d/development/common.local
 
       - name: Install Playwright Browsers
         run: cd src/frontend/apps/e2e && yarn install --frozen-lockfile && yarn install-playwright chromium
@@ -119,7 +119,7 @@ jobs:
           fail-on-cache-miss: true
 
       - name: Set e2e env variables
-        run: cat env.d/development/common.e2e.dist >> env.d/development/common.dist
+        run: cat env.d/development/common.e2e >> env.d/development/common.local
 
       - name: Install Playwright Browsers
         run: cd src/frontend/apps/e2e && yarn install --frozen-lockfile && yarn install-playwright firefox webkit chromium

.gitignore

@@ -40,8 +40,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
-env.d/development/*
-!env.d/development/*.dist
+env.d/development/*.local
 env.d/terraform
 
 # npm

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to
 ### Changed
 
 - ⚡️(docker) Optimize Dockerfile to use apk with --no-cache #743
+- 🔧(project) change env.d system by using local files #1200
 
 ### Fixed
 

Makefile

@@ -67,18 +67,18 @@ data/static:
 
 # -- Project
 
-create-env-files: ## Copy the dist env files to env files
-create-env-files: \
-	env.d/development/common \
-	env.d/development/crowdin \
-	env.d/development/postgresql \
-	env.d/development/kc_postgresql
-.PHONY: create-env-files
+create-env-local-files: ## create env.local files in env.d/development
+create-env-local-files: 
+	@touch env.d/development/crowdin.local
+	@touch env.d/development/common.local
+	@touch env.d/development/postgresql.local
+	@touch env.d/development/kc_postgresql.local
+.PHONY: create-env-local-files
 
 pre-bootstrap: \
 	data/media \
 	data/static \
-	create-env-files
+	create-env-local-files
 .PHONY: pre-bootstrap
 
 post-bootstrap: \
@@ -258,20 +258,6 @@ resetdb: ## flush database and create a superuser "admin"
 	@${MAKE} superuser
 .PHONY: resetdb
 
-env.d/development/common:
-	cp -n env.d/development/common.dist env.d/development/common
-
-env.d/development/postgresql:
-	cp -n env.d/development/postgresql.dist env.d/development/postgresql
-
-env.d/development/kc_postgresql:
-	cp -n env.d/development/kc_postgresql.dist env.d/development/kc_postgresql
-
-# -- Internationalization
-
-env.d/development/crowdin:
-	cp -n env.d/development/crowdin.dist env.d/development/crowdin
-
 crowdin-download: ## Download translated message from crowdin
 	@$(COMPOSE_RUN_CROWDIN) download -c crowdin/config.yml
 .PHONY: crowdin-download

compose-e2e.yml

@@ -24,5 +24,6 @@ services:
     restart: unless-stopped
     env_file:
       - env.d/development/common
+      - env.d/development/common.local
     ports:
       - "4444:4444"

compose.yml

@@ -10,6 +10,7 @@ services:
       retries: 300
     env_file:
       - env.d/development/postgresql
+      - env.d/development/postgresql.local
     ports:
       - "15432:5432"
 
@@ -66,7 +67,9 @@ services:
       - DJANGO_CONFIGURATION=Development
     env_file:
       - env.d/development/common
+      - env.d/development/common.local
       - env.d/development/postgresql
+      - env.d/development/postgresql.local
     ports:
       - "8071:8000"
     volumes:
@@ -91,7 +94,9 @@ services:
       - DJANGO_CONFIGURATION=Development
     env_file:
       - env.d/development/common
+      - env.d/development/common.local
       - env.d/development/postgresql
+      - env.d/development/postgresql.local
     volumes:
       - ./src/backend:/app
       - ./data/static:/data/static
@@ -135,6 +140,7 @@ services:
       - ".:/app"
     env_file:
       - env.d/development/crowdin
+      - env.d/development/crowdin.local
     user: "${DOCKER_USER:-1000}"
     working_dir: /app
 
@@ -156,6 +162,7 @@ services:
     restart: unless-stopped
     env_file:
       - env.d/development/common
+      - env.d/development/common.local
     ports:
       - "4444:4444"
     volumes:
@@ -174,6 +181,7 @@ services:
       - "5433:5432"
     env_file:
       - env.d/development/kc_postgresql
+      - env.d/development/kc_postgresql.local
 
   keycloak:
     image: quay.io/keycloak/keycloak:20.0.1