docs(Makefile): add help messages

This commit is contained in:
Sarah Vaupel 2025-03-25 15:33:45 +01:00
parent d55efd77f7
commit e7c7ec7a82

View File

@ -38,9 +38,9 @@ endif
-rf -rf backend/.stack -rf -rf backend/.stack
# TODO: only release when build and tests are passing!!!
.PHONY: release .PHONY: release
# HELP: create, commit and push a new release # HELP: create, commit and push a new release
# TODO: only release when build and tests are passing!!!
release: release:
VERSION=`./utils/version.pl -changelog CHANGELOG.md -v` ; \ VERSION=`./utils/version.pl -changelog CHANGELOG.md -v` ; \
git add CHANGELOG.md ; \ git add CHANGELOG.md ; \
@ -53,6 +53,7 @@ release:
# HELP: perform full compilation (frontend and backend) # HELP: perform full compilation (frontend and backend)
compile: compile-frontend compile-backend ; compile: compile-frontend compile-backend ;
.PHONY: compile-% .PHONY: compile-%
# HELP(compile-$SERVICE): compile a given service once
compile-%: compile-%:
docker compose run --remove-orphans --build --no-deps $* make compile docker compose run --remove-orphans --build --no-deps $* make compile
@ -61,27 +62,34 @@ compile-%:
start: start-postgres start-maildev start-memcached start-minio start-backend start: start-postgres start-maildev start-memcached start-minio start-backend
docker compose run backend make start docker compose run backend make start
.PHONY: start-% .PHONY: start-%
# HELP(start-$SERVICE): start a given service
start-%: start-%:
docker compose up -d --build $* docker compose up -d --build $*
.PHONY: stop .PHONY: stop
# HELP: stop all services
stop: stop:
docker compose down docker compose down
.PHONY: stop-% .PHONY: stop-%
# HELP(stop-$SERVICE): stop a given service
stop-%: stop-%:
docker compose down $* docker compose down $*
.PHONY: kill-% .PHONY: kill-%
# HELP(kill-$SERVICE): kill a given service the hard way. Use this if the servive does not respond to stop.
kill-%: kill-%:
docker compose kill $* docker compose kill $*
.PHONY: status .PHONY: status
# HELP: print an overview of currently running services and their health
status: status:
docker compose ps docker compose ps
.PHONY: top .PHONY: top
# HELP: print an overview of the ressource usage of the currently running services
top: top:
docker compose stats docker compose stats
.PHONY: log-% .PHONY: log-%
# HELP(log-$SERVICE): follow the output of a given service. Service must be running.
log-%: log-%:
docker compose logs --follow --timestamps $* docker compose logs --follow --timestamps $*