Makefile rework

.github/workflows/pick-to-staging.yml

@@ -63,4 +63,3 @@ jobs:
           reviewers: ${{ github.event.pull_request.user.login }}
           assignees: ${{ github.event.pull_request.user.login }}
           labels: picked-to-staging
-          milestone: 4

AUTHORS

@@ -39,13 +39,14 @@ Authors of OpenSlides in chronological order of first contribution:
     Adrian Richter <adrian@intevation.de>
     Camille Akmut
     Johannes Rolf <johannes.rolf@rwth-aachen.de>
-    Luisa Beerboom <luisa.beerboom@intevation.de
-    Magnus Schieder
+    Luisa Beerboom <luisa.beerboom@intevation.de>
+    Magnus Schieder <magnus.schieder@intevation.de>
     Bastian Rihm <brihm@intevation.de>
     Abdullah Şevik <a.alveolus@icloud.com>
     Loki Elble <loki.elble@intevation.de>
     Danny Reichelt <dreichelt@intevation.de>
     Hannes Janott <hannes.janott@openslides.com>
     Annalena Bebenroth <annalena.bebenroth@intevation.de>
+    Kasimir Klinger <kasimir.klinger@intevation.de>
     Viktoriia Krasnovyd <viktoriia.krasnovyd@intevation.de>
     Jan Malte Behrens <jan.malte.behrens@intevation.de>

DEVELOPMENT.md

@@ -18,7 +18,7 @@ After cloning you need to initialize all submodules:
 
 Finally, start the development server:
 
-    $ make run-dev
+    $ make dev
 
 (This command won't run without sudo, or without having set up Docker to run without sudo - see their documentation)
 
@@ -27,9 +27,11 @@ or access the full stack on
 
     $ https://localhost:8000
 
+Login as admin with ´admin´ as both username and password.
+
 ## Running tests
 
-To run all tests of all services, execute `run-service-tests`.
+To run all tests of all services, execute `run-tests`.
 
 ## Translations
 
@@ -38,7 +40,7 @@ functionality for this is bundled in this repository. The following make command
 
 -   `make extract-translations`: Extracts all strings which need translations from all services and
     merges them together into a single `template-en-pot`, which is placed under `i18n/`. You must
-    run `make run-dev` in another terminal before you can execute this command.
+    run `make dev` in another terminal before you can execute this command.
 -   `make push-translations`: Push the current template file under `i18n/template-en.pot` to Transifex
     to allow translating it there.
 -   `make pull-translations`: Pull the translations in all languages available in the client from
@@ -164,7 +166,7 @@ Go to the service and create a new branch (from main):
 
 Run OpenSlides in development mode (e.g. in a new terminal):
 
-    $ make run-dev
+    $ make dev
 
 After making some changes in my-service, create a commit and push to your fork
 
@@ -216,13 +218,13 @@ Sometimes it might be helpful to be able to run tests in the backend console and
 parallel. To circumvent the need to restart the full stack every time you switch contexts, there
 exist the `docker/docker-compose.test.yml` which introduces another database container to the stack.
 
-By default (meaning by running `make run-dev`), the setup uses the normal `postgres` container. We
+By default (meaning by running `make dev`), the setup uses the normal `postgres` container. We
 call this the `dev` context. By executing `make switch-to-test`, you can replace the database
 container and automatically restarting all dependent services, thus changing into the so-called
 `test` context. With `make switch-to-dev`, you can switch back. Finally, `make run-backend` provides
 a shortcut to switch to the `test` context and enter the backend shell to e.g. execute tests there.
 Be aware that all these commands need an OpenSlides instance to be already running, meaning you have
-to execute `make run-dev` first.
+to execute `make dev` first.
 
 ## Helper scripts
 

Makefile

@@ -1,75 +1,52 @@
-DEV_PATH=dev
-DOCKER_PATH=$(DEV_PATH)/docker
-SCRIPT_PATH=$(DEV_PATH)/scripts
-DC_DEV=docker compose -f $(DOCKER_PATH)/docker-compose.dev.yml
-DC_TEST=docker compose -f $(DOCKER_PATH)/docker-compose.test.yml
-GO_VERSION=$(shell head -n 1 go.work)
-
-# Main command: start the dev server
-run-dev: | build-dev 
-	$(DC_DEV) up $(ARGS)
+override DEV_PATH=dev
+override DOCKER_PATH=$(DEV_PATH)/docker
+override SCRIPT_PATH=$(DEV_PATH)/scripts
+override MAKEFILE_PATH=$(SCRIPT_PATH)/makefile
+override DC_DEV=docker compose -f $(DOCKER_PATH)/docker-compose.dev.yml
+override DC_TEST=docker compose -f $(DOCKER_PATH)/docker-compose.test.yml
+override GO_VERSION=$(shell head -n 1 go.work)
+override DOCKER_COMPOSE_FILE=$(DOCKER_PATH)/docker-compose.dev.yml
 
-# Main command: start the dev server in detached mode
-run-dev-detached: | build-dev 
-	$(DC_DEV) up $(ARGS) -d
 
-# Same as run-dev, but with OpenTelemetry
-run-dev-otel: | build-dev
-	$(DC_DEV) -f $(DOCKER_PATH)/dc.otel.dev.yml up $(ARGS)
+# Build images for different contexts
 
-# Build the docker dev images for all services in parallel
-build-dev:
-	sed -i "1s/.*/$(GO_VERSION)/" $(DOCKER_PATH)/workspaces/*.work
-	chmod +x $(SCRIPT_PATH)/makefile/build-all-submodules.sh
-	$(SCRIPT_PATH)/makefile/build-all-submodules.sh
+build-prod build-dev build-tests:
+	sed -i -e "1s/.*/$(GO_VERSION)/" $(DOCKER_PATH)/workspaces/*.work
+	bash $(MAKEFILE_PATH)/make-build-main.sh $@
 
-# Run the tests of all services
-run-service-tests:
-	chmod +x $(SCRIPT_PATH)/makefile/test-all-submodules.sh
-	$(SCRIPT_PATH)/makefile/test-all-submodules.sh
+build:
+	$(DOCKER_PATH)/build.sh
 
-run-tests:
-	bash dev/scripts/makefile/test-all-submodules.sh
-# Execute while run-dev is running: Switch to the test database to execute backend tests without
-# interfering with your dev database
-switch-to-test:
-	$(DC_DEV) stop postgres
-	$(DC_TEST) up -d postgres-test
-	$(DC_DEV) -f $(DOCKER_PATH)/docker-compose.backend.yml up -d backend
-	$(DC_DEV) restart datastore-writer datastore-reader autoupdate vote
+# Development
+.SERVICE_TARGETS := auth autoupdate backend client datastore icc manage media proxy search vote
 
-# Execute while run-dev is running: Switch back to your dev database
-switch-to-dev:
-	$(DC_TEST) stop postgres-test
-	$(DC_DEV) up -d postgres backend
-	$(DC_DEV) restart datastore-writer datastore-reader autoupdate vote 
+$(.SERVICE_TARGETS):
+	@echo ""
 
-# Shorthand to directly enter a shell in the backend after switching the databases
-run-backend: | switch-to-test
-	$(DC_DEV) exec backend ./entrypoint.sh bash --rcfile .bashrc
+.FLAGS := no-cache capsule compose-local-branch
 
-# Stop all backend-related services so that the backend dev setup can start
-stop-backend:
-	$(DC_DEV) stop backend datastore-reader datastore-writer auth vote postgres redis icc autoupdate search
+$(.FLAGS):
+	@echo ""
 
-# Restart all backend-related services
-start-backend:
-	$(DC_DEV) up -d backend datastore-reader datastore-writer auth vote postgres redis icc autoupdate search
+.PHONY: dev
 
-# Stop the dev server
-stop-dev:
-	$(DC_DEV) down --volumes --remove-orphans
+dev dev-help dev-standalone dev-detached dev-attached dev-stop dev-exec dev-enter dev-clean dev-build dev-log:
+	@sed -i "1s/.*/$(GO_VERSION)/" $(DOCKER_PATH)/workspaces/*.work
+	@bash $(MAKEFILE_PATH)/make-dev.sh $@ "$(filter-out $@, $(MAKECMDGOALS))"
 
-# Stop the dev server with OpenTelemetry
-stop-dev-otel:
-	$(DC_DEV) -f $(DOCKER_PATH)/dc.otel.dev.yml down --volumes --remove-orphans
+# Tests
 
-build:
-	$(DOCKER_PATH)/build.sh
+run-tests:
+	bash dev/scripts/makefile/test-all-submodules.sh "$(filter-out $@, $(MAKECMDGOALS))"
+
+test-ci:
+	bash $(SCRIPT_PATH)/act/run-act.sh $(FOLDER) $(WORKFLOW_TRIGGER)
+
+# Make-release commands
 
-# Shorthands to execute the make-release script
 services-to-main:
 	$(SCRIPT_PATH)/make-update.sh fetch-all-changes $(ARGS)
+
 services-to-main-pull:
 	$(SCRIPT_PATH)/make-update.sh fetch-all-changes --pull $(ARGS)
 
@@ -85,12 +62,6 @@ hotfix-update:
 stable-update:
 	$(SCRIPT_PATH)/make-update.sh stable $(ARGS)
 
-# You may only use this one time after cloning this repository.
-# Will set the upstream remote to "origin"
-submodules-origin-to-upstream:
-	git submodule foreach -q --recursive 'git remote rename origin upstream'
-
-
 # Translation helper targets
 
 extract-translations:
@@ -106,8 +77,76 @@ copy-translations:
 	cp i18n/*.po openslides-client/client/src/assets/i18n/
 	cp i18n/*.po openslides-backend/openslides_backend/i18n/messages/
 
-clean-run-dev:
-	docker stop $(shell docker ps -aq) || true
-	docker rm $(shell docker ps -a -q) || true
-	docker rmi -f $(shell docker images -aq) || true
-	make run-dev
+
+
+
+########################## Deprecation List ##########################
+
+deprecation-warning:
+	@echo "\033[1;33m DEPRECATION WARNING: This make command is deprecated and will be removed soon! \033[0m"
+
+deprecation-warning-alternative: | deprecation-warning
+	@echo "\033[1;33m Please use the following command instead: $(ALTERNATIVE) \033[0m"
+
+run-dev:
+	@make deprecation-warning-alternative ALTERNATIVE="dev"
+	sed -i "1s/.*/$(GO_VERSION)/" $(DOCKER_PATH)/workspaces/*.work
+	chmod +x $(SCRIPT_PATH)/makefile/build-all-submodules.sh
+	$(DC_DEV) up $(ARGS)
+
+run-dev-detached:
+	@make deprecation-warning-alternative ALTERNATIVE="dev"
+	sed -i "1s/.*/$(GO_VERSION)/" $(DOCKER_PATH)/workspaces/*.work
+	chmod +x $(SCRIPT_PATH)/makefile/build-all-submodules.sh
+	$(DC_DEV) up $(ARGS) -d
+
+stop-dev:
+	@make deprecation-warning-alternative ALTERNATIVE="dev-stop"
+	$(DC_DEV) down --volumes --remove-orphans
+
+# Run the tests of all services
+run-service-tests:
+	@make deprecation-warning-alternative ALTERNATIVE="run-tests"
+	chmod +x $(SCRIPT_PATH)/makefile/test-all-submodules.sh
+	$(SCRIPT_PATH)/makefile/test-all-submodules.sh
+
+# Execute while run-dev is running: Switch to the test database to execute backend tests without
+# interfering with your dev database
+switch-to-test: | deprecation-warning
+	$(DC_DEV) stop postgres
+	$(DC_TEST) up -d postgres-test
+	$(DC_DEV) -f $(DOCKER_PATH)/docker-compose.backend.yml up -d backend
+	$(DC_DEV) restart datastore-writer datastore-reader autoupdate vote
+
+# Execute while run-dev is running: Switch back to your dev database
+switch-to-dev: | deprecation-warning
+	$(DC_TEST) stop postgres-test
+	$(DC_DEV) up -d postgres backend
+	$(DC_DEV) restart datastore-writer datastore-reader autoupdate vote
+
+# Shorthand to directly enter a shell in the backend after switching the databases
+run-backend: | deprecation-warning switch-to-test
+	$(DC_DEV) exec backend ./entrypoint.sh bash --rcfile .bashrc
+
+# Stop all backend-related services so that the backend dev setup can start
+stop-backend: | deprecation-warning
+	$(DC_DEV) stop backend datastore-reader datastore-writer auth vote postgres redis icc autoupdate search
+
+# Restart all backend-related services
+start-backend: | deprecation-warning
+	$(DC_DEV) up -d backend datastore-reader datastore-writer auth vote postgres redis icc autoupdate search
+
+
+# Stop the dev server with OpenTelemetry
+stop-dev-otel: | deprecation-warning
+	$(DC_DEV) -f $(DOCKER_PATH)/dc.otel.dev.yml down --volumes --remove-orphans
+
+
+# Same as run-dev, but with OpenTelemetry
+run-dev-otel: | deprecation-warning build-dev
+	$(DC_DEV) -f $(DOCKER_PATH)/dc.otel.dev.yml up $(ARGS)
+
+# You may only use this one time after cloning this repository.
+# Will set the upstream remote to "origin"
+submodules-origin-to-upstream: | deprecation-warning
+	git submodule foreach -q --recursive 'git remote rename origin upstream'

VERSION

@@ -1 +1 @@
-4.2.8-dev
+4.2.21-dev