fraport/fradrive
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(Makefile): add documentation (make help)

Browse Source
This commit is contained in:
Sarah Vaupel 2024-10-17 04:59:03 +02:00
parent 78dea1e17d
commit b6f7e8af5f
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Makefile
View File

@ -279,7 +279,7 @@ serve-database: --containerized-database;
$(MAKE) -- --image-run-$*-database $(MAKE) -- --image-run-$*-database
.PHONY: image-rebuild .PHONY: image-rebuild
# HELP: rebuild the stated docker image (frontend, backend, database instead of %) # HELP(image-rebuild-{backend,frontend,database,memcached,minio}): force-rebuild the stated docker image
image-rebuild-%: image-rebuild-%:
$(MAKE) -- --image-build FRADRIVE_SERVICE=$* NO_CACHE=--no-cache $(MAKE) -- --image-build FRADRIVE_SERVICE=$* NO_CACHE=--no-cache
--image-build: --image-build:
@ -335,7 +335,6 @@ SET_DEVELOP = $(eval DEVELOP=develop/`ls -1 develop | tail -n1`)
NEW_DEVELOP = $(eval DEVELOP=develop/$$(DATE)) NEW_DEVELOP = $(eval DEVELOP=develop/$$(DATE))
.PHONY: new-develop .PHONY: new-develop
# HELP:
new-develop: new-develop:
$(NEW_DEVELOP) $(NEW_DEVELOP)
mkdir -p $(DEVELOP) mkdir -p $(DEVELOP)
@ -370,8 +369,15 @@ start-hoogle: BASE_PORTS = "HOOGLE_PORT=8081"
start-hoogle: SINGLETON=true start-hoogle: SINGLETON=true
start-frontend: SINGLETON = false start-frontend: SINGLETON = false
start-frontend: WATCH = true start-frontend: WATCH = false
# HELP(start-database): start postgres server
# HELP(start-memcached): start memcached server
# HELP(start-minio): start minio server
# HELP(start-backend): serve yesod development site
# HELP(start-frontend): start frontend watcher. Watches frontend source files for changes and recompiles on change. (TODO: watcher functionality currently broken!)
# HELP(start-hoogle): serve local hoogle instance
# TODO: abort with error if a singleton service is already running
start-%: FRADRIVE_SERVICE = % start-%: FRADRIVE_SERVICE = %
start-%: PORTS = $(foreach PORT,$(BASE_PORTS),$(shell utils/next_free_port.pl $(PORT))) start-%: PORTS = $(foreach PORT,$(BASE_PORTS),$(shell utils/next_free_port.pl $(PORT)))
start-%: --ensure-develop start-%: --ensure-develop
@ -411,10 +417,12 @@ start-%: --ensure-develop
# CONTAINER_ID=`$(CONTAINER_RUN) -v $(PWD):/mnt/fradrive --file docker/minio/Dockerfile -- (server $${MINIO_DIR})` ; \ # CONTAINER_ID=`$(CONTAINER_RUN) -v $(PWD):/mnt/fradrive --file docker/minio/Dockerfile -- (server $${MINIO_DIR})` ; \
# echo "CONTAINER_ID=$${CONTAINER_ID}" >> $(DEVELOP)/minio # echo "CONTAINER_ID=$${CONTAINER_ID}" >> $(DEVELOP)/minio
# TODO: work in progress .PHONY: stop
# - kill container and remove file from .develop # HELP: stop all currently running develop instances
# TODO: find way to stop a single container, e.g. by removing the file stop:
rm -rf develop
.PHONY: stop-% .PHONY: stop-%
# HELP(stop-{database,memcached,minio,backend,frontend,hoogle}): stop all currently running develop instances of a given type
stop-%: --stop-% stop-%: --stop-%
rm -rf $(DEVELOP)/$* rm -rf $(DEVELOP)/$*
stop-container-by-file: stop-container-by-file:
@ -425,6 +433,7 @@ stop-container-by-id:
# $(MAKE) stop-container-by-id CONTAINER_ID=$${CONTAINER_ID} # $(MAKE) stop-container-by-id CONTAINER_ID=$${CONTAINER_ID}
.PHONY: log-% .PHONY: log-%
# HELP(log-{database,memcached,minio,backend,frontend,hoogle}): inspect output of a given (currently running) service. When a service supports multiple running instances in one develop (i.e. backend), you need to specify the exact instance by its associated file (e.g. backend-1, backend-2, etc.), please check the contents of the develop/ directory for a list of running instances.
log-%: log-%:
$(CONTAINER_COMMAND) logs --follow --tail=$(LOGSIZE) `cat develop/$(CURRENT_DEVELOP)/$* | grep CONTAINER_ID= | sed 's/^CONTAINER_ID=//'` $(CONTAINER_COMMAND) logs --follow --tail=$(LOGSIZE) `cat develop/$(CURRENT_DEVELOP)/$* | grep CONTAINER_ID= | sed 's/^CONTAINER_ID=//'`
@ -435,6 +444,8 @@ log-%:
# TODO: move targets below to better location # TODO: move targets below to better location
# Some convenience aliases: # Some convenience aliases:
.PHONY: hoogle
# HELP: alias for start-hoogle
hoogle: start-hoogle; hoogle: start-hoogle;
.PHONY: i18n-check .PHONY: i18n-check