build(Makefile): update documentation

This commit is contained in:
Sarah Vaupel 2024-11-13 04:00:52 +01:00
parent 9f862bcfd6
commit 81f689cfdf

View File

@ -27,9 +27,6 @@ export CONTAINER_ATTACHED
export CONTAINER_INIT
export CONTAINER_CLEANUP
# export STACK_INIT="./utils/stack-work-init.sh"
# export STACK_CLEANUP="rm -f .stack-work.lock"
export SERVICE
export SERVICE_VARIANT ?= $(SERVICE)
export JOB
@ -187,7 +184,7 @@ shell-%: CF_PREFIX=shell-
shell-%: CONTAINER_ATTACHED=true
shell-%: --act ;
.PHONY: ghci
# HELP: launch new backend instance and enter interactive ghci shell (WIP)
# HELP(ghci): launch new backend instance and enter interactive ghci shell
ghci: shell-ghci;
--act: --develop_containerized;
@ -205,7 +202,7 @@ ghci: shell-ghci;
$(MAKE) -- --$* CONTAINER_FILE=$${CONTAINER_FILE} CONTAINER_IDENT=$${CONTAINER_IDENT} JOB=$(JOB)
.PHONY: rebuild-%
# HELP(rebuild-{backend,frontend,database,memcached,minio}): force-rebuild the stated docker image
# HELP(rebuild-{backend,frontend,database,memcached,minio}): force-rebuild a given container image
rebuild-%:
$(MAKE) -- --image-build SERVICE=$* NO_CACHE=--no-cache
--image-build:
@ -309,7 +306,7 @@ static: node_modules assets esbuild.config.mjs
npm run build
well-known: static;
# HELP(compile-uniworxdb): clear and fill database. requires running postgres
# HELP(compile-uniworxdb): clear and fill database. requires running postgres instance (use "make start-postgres" to start one)
# TODO (db-m-$MIGRATION-backend): apply migration (see src/Model/Migration/Definition.hs for list of available migrations)
--compile-uniworxdb: --compile-backend
SERVER_SESSION_ACID_FALLBACK=${SERVER_SESSION_ACID_FALLBACK:-true} ; \
@ -320,6 +317,7 @@ well-known: static;
stack exec -- ghci
# --main-is uniworx:exe:uniworx
# HELP(shell-{backend,frontend,memcached,minio,postgres}): enter (bash) shell inside a new container of a given service
--shell-%:
/bin/bash