Makefile for dockerized PHP applications with available targets on the same file
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
.PHONY: no_targets__ info help build deploy doc | |
no_targets__: | |
.DEFAULT_GOAL := help | |
#----------------------------------------------------------------- | |
# CONSTANTS | |
#----------------------------------------------------------------- | |
ifneq (,$(findstring xterm,${TERM})) | |
BLACK := $(shell tput -Txterm setaf 0) | |
RED := $(shell tput -Txterm setaf 1) | |
GREEN := $(shell tput -Txterm setaf 2) | |
YELLOW := $(shell tput -Txterm setaf 3) | |
BLUE := $(shell tput -Txterm setaf 4) | |
MAGENTA := $(shell tput -Txterm setaf 5) | |
CYAN := $(shell tput -Txterm setaf 6) | |
WHITE := $(shell tput -Txterm setaf 7) | |
RESET := $(shell tput -Txterm sgr0) | |
else | |
BLACK := "" | |
RED := "" | |
GREEN := "" | |
YELLOW := "" | |
BLUE := "" | |
MAGENTA := "" | |
CYAN := "" | |
WHITE := "" | |
RESET := "" | |
endif | |
TARGET_COLOR := $(YELLOW) | |
SERVICE_NAME = api | |
#----------------------------------------------------------------- | |
# HELP | |
#----------------------------------------------------------------- | |
help: | |
@echo "ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β β" | |
@echo "β ${CYAN}.:${RESET} AVAILABLE COMMANDS ${CYAN}:.${RESET} β" | |
@echo "β β" | |
@echo "ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@grep -E '^[a-zA-Z_0-9%-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "Β· ${TARGET_COLOR}%-30s${RESET} %s\n", $$1, $$2}' | |
@echo "" | |
#----------------------------------------------------------------- | |
# MISCELANEOUS | |
#----------------------------------------------------------------- | |
check-required-param-%: | |
@if [ -z "$($(*))" ] ; then \ | |
echo "" ; \ | |
echo " β ${RED}Parameter [ ${WHITE}${*}${RED} ] is required!${RESET}" ; \ | |
echo "" ; \ | |
exit 1 ; \ | |
fi; | |
#----------------------------------------------------------------- | |
# DOCKER-COMPOSE RELATED | |
#----------------------------------------------------------------- | |
build: ## Builds the container(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β BUILDING THE SERVICE(s) β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose build | |
@echo " π¦ ${GREEN}Build done!${RESET}" | |
@echo "" | |
build: ## Builds the container(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β BUILDING THE SERVICE(s) β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose build | |
@echo " π¦ ${GREEN}Service has been built!${RESET}" | |
@echo "" | |
rebuild: down build ## Rebuilds the container(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β REBUILDING THE SERVICE(s) β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose up --remove-orphans | |
@echo " π¦ ${CYAN}Service has been rebuilt!${RESET}" | |
@echo "" | |
up: check-folder ## Starts the container(s) in daemonized mode | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β BUILDING, (RE)CREATING, STARTING AND ATTACHING TO CONTAINERS FOR A SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose up --remove-orphans -d | |
@echo "" | |
@echo " π’ ${GREEN}Service is up & running!${RESET}" | |
@echo "" | |
down: ## Stops the container(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β STOPPING AND REMOVING CONTAINERS, NETWORKS, VOLUMES AND IMAGES β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose down | |
@echo "" | |
@echo " π ${YELLOW}Service has been stopped!${RESET}" | |
@echo "" | |
restart: ## Restarts the container(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β RESTARTING ALL STOPPED AND RUNNING SERVICES β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose restart | |
@echo "" | |
@echo " π΅ ${BLUE}Service has been restarted!${RESET}" | |
@echo "" | |
logs: ## Prints out the container(s) log(s) | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β DISPLAYING LOG OUTPUT FROM SERVICES β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose logs | |
@echo "" | |
@echo " π ${WHITE}Service log were displayed!${RESET}" | |
@echo "" | |
#----------------------------------------------------------------- | |
# SERVICE RELATED | |
#----------------------------------------------------------------- | |
bash: ## Opens a bash connection to main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β GETTING AN INTERACTIVE PROMPT FROM SERVICE CONTAINER β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
info: ## Displays information about main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β DISPLAYING GENERIC INFORMATION FROM SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "php --version" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
#----------------------------------------------------------------- | |
# COMPOSER RELATED | |
#----------------------------------------------------------------- | |
composer-install-no-dev: ## Performs <composer install --optimize-autoloader --no-dev> onto main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β INSTALLING DEPENDENCIES ONTO APPLICATION SERVICE IN PRODUCTION MODE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "COMPOSER_MEMORY_LIMIT=-1 composer install --optimize-autoloader --no-dev" | |
@echo "" | |
composer-install: ## Performs <composer install --optimize-autoloader> onto main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β INSTALLING DEPENDENCIES ONTO APPLICATION SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "COMPOSER_MEMORY_LIMIT=-1 composer install --optimize-autoloader" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
composer-update: ## Performs <composer update> onto main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β UPDATING DEPENDENCIES ONTO APPLICATION SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "COMPOSER_MEMORY_LIMIT=-1 composer update" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
composer-dump-auto: ## Performs <composer dump-auto> onto main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β GENERATING OPTIMIZED AUTOLOAD CLASS MAP ONTO APPLICATION SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "COMPOSER_MEMORY_LIMIT=-1 composer dump-auto" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
#----------------------------------------------------------------- | |
# APPLICATION RELATED | |
#----------------------------------------------------------------- | |
tests: ## Executes the PHPUnit testsuite onto main service | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β RUNNING THE TESTSUITE ONTO APPLICATION SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "cd /code/api && ./vendor/bin/phpunit" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
tests-debug: ## Executes the PHPUnit testsuite with debug flag | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β RUNNING THE TESTSUITE ONTO APPLICATION SERVICE IN DEBUG MODE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "cd /code/api && ./vendor/bin/phpunit --debug" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" | |
cache-clear: ## Performs <php artisan clear:cache> onto app container | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "β CLEARING THE APPLICATION CACHE FROM APPLICATION SERVICE β" | |
@echo "βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ" | |
@echo "" | |
@docker-compose exec ${SERVICE_NAME} bash -c "cd /code/api && php artisan cache:clear" | |
@echo "" | |
@echo " β ${GREEN}Task is done!${RESET}" | |
@echo "" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment