1
0
Fork 0
mirror of https://gitlab.com/bramw/baserow.git synced 2025-01-28 18:09:49 +00:00
bramw_baserow/Makefile
2025-01-24 12:43:14 +01:00

219 lines
6.6 KiB
Makefile

ifeq ($(shell uname -s),Darwin)
REALPATH:=grealpath -em
else
REALPATH:=realpath -em
endif
SHELL=/bin/bash
WORKDIR:=$(shell $(REALPATH) $(shell pwd))
SUBDIRS:=backend web-frontend
DOCKERCLI:=docker
DOCKERC:=$(DOCKERCLI) compose --env-file .env.docker
DOCKER_SPLIT_CONF:=-f docker-compose.yml -f docker-compose.dev.yml
DOCKER_ALL_IN_ONE_CONF:=-f deploy/all-in-one/docker-compose.dev.yml
ALL_IN_ONE_CONTAINER_NAME:=baserow_all_in_one_dev
.PHONY: install build .callsubcmd $(SUBDIRS) help package-build test tests\
lint lint-fix docker-lint changelog\
docker-status docker-build docker-start docker-clean docker-stop docker-kill \
deps deps-upgrade \
clean clean-all
help:
@echo "baserow make. available targets:"
@echo "targets that are executed in backend/frontend dirs:"
@echo " make install - install locally with dependencies"
@echo " make package-build - build packages locally"
@echo " make lint - check code style"
@echo " make test - run test suite"
@echo " make changelog - add a new changelog entry"
@echo " make clean-all - remove docker images, venv and frontend node_modules dir"
@echo " "
@echo "targets that are executed at top-dir level:"
@echo ""
@echo " make docker-build - build docker images for dev env"
@echo " make docker-start - start local dev env"
@echo " make docker-stop - stop local dev env"
@echo " make docker-status - show current docker containers"
@echo " make docker-clean - remove docker images"
@echo " make docker-lint - validate dockerfiles"
@echo ""
@echo " make docker-backend-shell - start a shell in backend container"
@echo " make docker-backend-logs - follow logs in backend container"
@echo " make docker-backend-attach - attach to backend container"
@echo ""
@echo " make docker-frontend-shell - start a shell in frontend container"
@echo " make docker-frontend-logs - follow logs in frontend container"
@echo " make docker-frontend-attach - attach to frontend container"
@echo ""
@echo " make docker-allinone-build - build all-in-one dev container"
@echo " make docker-allinone-start - start all-in-one dev container"
@echo " make docker-allinone-stop - stop all-in-one dev container"
@echo " make docker-allinone-reload - reload supervised processes in the all-in-one container"
@echo ""
# create .env file with default values if no file exists
.env:
@cat .env.example > .env
@echo "### DEV VARS" >> .env
@cat .env.dev.example >> .env
@sed -i'' -e 's/replace me with your uid/$(shell id -u)/g' .env
@sed -i'' -e 's/replace me with your gid/$(shell id -g)/g' .env
@echo "Created .env file with default values"
@echo "Please review contents of .env"
@echo ""
# execute $(SUBCMD) in subdirs with make
# NOTE: SUBCMD is substituted at rule level while $SDIR is shell variable
.subcmd:
@echo "calling $(SUBCMD) in subdirs"
for SDIR in $(SUBDIRS); do echo "$$SDIR/$(SUBCMD)"; \
cd $(WORKDIR) && cd $$SDIR && $(MAKE) $(SUBCMD) && cd ..; \
done
# NOTE: each target that need to call subdir mae
install: SUBCMD=install deps-install deps-install-dev
install: .subcmd
package-build: SUBCMD=package-build
package-build: .subcmd
lint: SUBCMD=lint
lint: .subcmd docker-lint
lint-fix: SUBCMD=lint-fix
lint-fix: .subcmd
test: SUBCMD=test
test: .subcmd
tests: test
changelog:
$(MAKE) -C changelog add
.docker-build: .env
$(DOCKERC) $(DOCKER_CONFIG_FILES) build
.docker-start: .env
$(DOCKERC) $(DOCKER_CONFIG_FILES) up -d
.docker-stop: .env
$(DOCKERC) $(DOCKER_CONFIG_FILES) stop
.docker-kill: .env
$(DOCKERC) $(DOCKER_CONFIG_FILES) kill
.docker-clean: .env
$(DOCKERC) $(DOCKER_CONFIG_FILES) rm -f -v
docker-build: DOCKER_CONFIG_FILES=$(DOCKER_SPLIT_CONF)
docker-build: .docker-build
docker-start: DOCKER_CONFIG_FILES=$(DOCKER_SPLIT_CONF)
docker-start: docker-build .docker-start
docker-stop: DOCKER_CONFIG_FILES=$(DOCKER_SPLIT_CONF)
docker-stop: .docker-stop
docker-kill: DOCKER_CONFIG_FILES=$(DOCKER_SPLIT_CONF)
docker-kill: .docker-kill
docker-clean: DOCKER_CONFIG_FILES=$(DOCKER_SPLIT_CONF)
docker-clean: docker-stop .docker-clean
docker-lint:
$(DOCKERCLI) run --rm -i -v "$(shell pwd)":/opt/hadolint/. -w /opt/hadolint \
hadolint/hadolint:2.9.3-debian \
hadolint -f tty \
--ignore DL3008 \
backend/Dockerfile \
web-frontend/Dockerfile \
heroku.Dockerfile \
e2e-tests/Dockerfile \
deploy/*/Dockerfile
# those images are required to build all-in-one image
.docker-build-standalone-images:
docker build -f backend/Dockerfile . -t baserow_backend
docker build -f web-frontend/Dockerfile . -t baserow_web-frontend
# builds production and dev all-in-one
# very slow
.docker-build-all-in-one: .docker-build-standalone-images
# produces web-frontend/.nuxt
# required by prod deployment
(cd web-frontend && make build)
# produces `baserow` image
# needed by deploy/all-in-one/dev.Dockerfile
# needed by deploy/all-in-one/docker-compose.dev.yml
$(DOCKERC) -f deploy/all-in-one/docker-compose.yml build
docker-allinone-build: DOCKER_CONFIG_FILES=$(DOCKER_ALL_IN_ONE_CONF)
docker-allinone-build: .docker-build-all-in-one .docker-build
docker-allinone-start: DOCKER_CONFIG_FILES=$(DOCKER_ALL_IN_ONE_CONF)
docker-allinone-start: docker-allinone-build .docker-start
docker-allinone-stop: DOCKER_CONFIG_FILES=$(DOCKER_ALL_IN_ONE_CONF)
docker-allinone-stop: .docker-stop
# tag locally, so we don't need to pull
docker-allinone-tag: docker-allinone-build
$(DOCKER) tag baserow:latest baserow/baserow:latest
docker-allinone-restart: docker-allinone-stop docker-allinone-start
docker-allinone-shell:
$(DOCKERC) $(DOCKER_ALL_IN_ONE_CONF) exec $(ALL_IN_ONE_CONTAINER_NAME) bash
# tell supervisor to reread configs and restart processes
docker-allinone-reload:
$(DOCKERC) $(DOCKER_ALL_IN_ONE_CONF) exec $(ALL_IN_ONE_CONTAINER_NAME) bash -c 'kill -HUP 1'
docker-allinone-attach:
$(DOCKERC) $(DOCKER_ALL_IN_ONE_CONF) attach $(ALL_IN_ONE_CONTAINER_NAME)
docker-allinone-logs:
$(DOCKERC) $(DOCKER_ALL_IN_ONE_CONF) logs -tf $(ALL_IN_ONE_CONTAINER_NAME)
docker-backend-shell:
$(DOCKERC) $(DOCKER_SPLIT_CONF) exec backend bash
docker-backend-attach:
$(DOCKERC) $(DOCKER_SPLIT_CONF) attach backend
docker-backend-logs:
$(DOCKERC) $(DOCKER_SPLIT_CONF) logs -tf backend
docker-frontend-shell:
$(DOCKERC) $(DOCKER_SPLIT_CONF) exec web-frontend bash
docker-frontend-attach:
$(DOCKERC) $(DOCKER_SPLIT_CONF) attach web-frontend
docker-frontend-logs:
$(DOCKERC) $(DOCKER_SPLIT_CONF) logs -tf web-frontend
clean: SUBCMD=clean
clean: .subcmd docker-clean
clean-all: SUBCMD=clean-all
clean-all: .subcmd docker-clean
deps: SUBCMD=deps
deps: .subcmd
deps-upgrade: SUBCMD=deps-upgrade
deps-upgrade: .subcmd
docker-status: .env
$(DOCKERC) $(DOCKER_SPLIT_CONF) ps