design-comuni-plone-theme/Makefile

Volto Theme for Italia design guidelines

# Yeoman Volto App development

### Defensive settings for make:
#     https://tech.davis-hansson.com/p/make/
SHELL:=bash
.ONESHELL:
.SHELLFLAGS:=-xeu -o pipefail -O inherit_errexit -c
.SILENT:
.DELETE_ON_ERROR:
MAKEFLAGS+=--warn-undefined-variables
MAKEFLAGS+=--no-builtin-rules

CURRENT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))

# Project settings
# Update the versions depending on your project requirements | Last Updated 2022-12-23
# DOCKER_IMAGE=plone/plone-backend:6.0
# KGS=
# TESTING_ADDONS=plone.app.robotframework==2.0.0 plone.app.testing==7.0.0
# NODEBIN = ./node_modules/.bin

# Plone 5 legacy
# DOCKER_IMAGE5=plone/plone-backend:5.2.9
# KGS5=plone.restapi==8.32.6 plone.volto==4.0.0 plone.rest==2.0.0

# DIR=$(shell basename $$(pwd))
# ADDON ?= "design-comuni-plone-theme"

PLONE_VERSION=6
VOLTO_VERSION=17.22.3

ADDON_NAME='design-comuni-plone-theme'
ADDON_PATH='design-comuni-plone-theme'
DEV_COMPOSE=dockerfiles/docker-compose.yml
ACCEPTANCE_COMPOSE=acceptance/docker-compose.yml
CMD=BUILDKIT_PROGRESS=plain CURRENT_DIR=${CURRENT_DIR} ADDON_NAME=${ADDON_NAME} ADDON_PATH=${ADDON_PATH} VOLTO_VERSION=${VOLTO_VERSION} PLONE_VERSION=${PLONE_VERSION} docker compose
DOCKER_COMPOSE=${CMD} -p ${ADDON_PATH} -f ${DEV_COMPOSE}
ACCEPTANCE=${CMD} -p ${ADDON_PATH}-acceptance -f ${ACCEPTANCE_COMPOSE}

# Recipe snippets for reuse

# We like colors
# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
RED=`tput setaf 1`
GREEN=`tput setaf 2`
RESET=`tput sgr0`
YELLOW=`tput setaf 3`


# Top-level targets

.PHONY: help
help:		## Show this help.
	@echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)"

.PHONY: demo
demo: docker-compose.yml ## Launch demo site
	make build-backend
	make start-backend
	make build-frontend
	make start-frontend

.PHONY: build-backend
build-backend: ## Build
	@echo "$(GREEN)==> Build Backend Container $(RESET)"
	${DOCKER_COMPOSE} build backend

.PHONY: start-backend
start-backend: ## Starts Docker backend
	@echo "$(GREEN)==> Start Docker-based Plone Backend $(RESET)"
	${DOCKER_COMPOSE} up backend -d

.PHONY: stop-backend
stop-backend: ## Stop Docker backend
	@echo "$(GREEN)==> Stop Docker-based Plone Backend $(RESET)"
	${DOCKER_COMPOSE} stop backend

.PHONY: build-frontend
build-frontend: ## Build frontend
	@echo "$(GREEN)==> Build Frontend Container $(RESET)"
	${DOCKER_COMPOSE} build addon-prod

.PHONY: start-frontend
start-frontend: ## Starts Docker frontend
	@echo "$(GREEN)==> Start Docker-based Volto Frontend $(RESET)"
	${DOCKER_COMPOSE} up addon-prod -d

.PHONY: stop-frontend
stop-frontend: ## Stop Docker frontend
	@echo "$(GREEN)==> Stop Docker-based Volto Frontend $(RESET)"
	${DOCKER_COMPOSE} stop addon-prod

.PHONY: build-addon
build-addon: ## Build Addon dev
	@echo "$(GREEN)==> Build Addon development container $(RESET)"
	${DOCKER_COMPOSE} build addon-dev

.PHONY: start-dev
start-dev: ## Starts Dev container
	@echo "$(GREEN)==> Start Addon Development container $(RESET)"
	${DOCKER_COMPOSE} up addon-dev

.PHONY: dev
dev: ## Develop the addon
	@echo "$(GREEN)==> Start Development Environment $(RESET)"
	make build-backend
	make start-backend
	make build-addon
	make start-dev

# Dev Helpers
.PHONY: i18n
i18n: ## Sync i18n
	${DOCKER_COMPOSE} --profile unittest run addon-dev i18n

.PHONY: format
format: ## Format codebase
	${DOCKER_COMPOSE} --profile unittest run addon-dev lint:fix
	${DOCKER_COMPOSE} --profile unittest run addon-dev prettier:fix
	${DOCKER_COMPOSE} --profile unittest run addon-dev stylelint:fix

.PHONY: lint
lint: ## Lint Codebase
	${DOCKER_COMPOSE} --profile unittest run addon-dev lint
	${DOCKER_COMPOSE} --profile unittest run addon-dev prettier
	${DOCKER_COMPOSE} --profile unittest run addon-dev stylelint

.PHONY: test
test: ## Run unit tests
	${DOCKER_COMPOSE} --profile unittest run addon-dev test --watchAll

.PHONY: test-ci
test-ci: ## Run unit tests in CI
	${DOCKER_COMPOSE} --profile unittest run -e CI=1 addon-dev test

## Acceptance
.PHONY: install-acceptance
install-acceptance: ## Install Cypress, build containers
	(cd acceptance && yarn)
	${ACCEPTANCE} --profile dev --profile prod build

.PHONY: start-test-acceptance-server
start-test-acceptance-server: ## Start acceptance server
	${ACCEPTANCE} --profile dev up -d

.PHONY: start-test-acceptance-server-prod
start-test-acceptance-server-prod: ## Start acceptance server
	${ACCEPTANCE} --profile prod up -d

.PHONY: test-acceptance
test-acceptance: ## Start Cypress
	(cd acceptance && ./node_modules/.bin/cypress open)

.PHONY: test-acceptance-headless
test-acceptance-headless: ## Run cypress tests in CI
	(cd acceptance && ./node_modules/.bin/cypress run)

.PHONY: stop-test-acceptance-server
stop-test-acceptance-server: ## Stop acceptance server
	${ACCEPTANCE} down

.PHONY: status-test-acceptance-server
status-test-acceptance-server: ## Status of Acceptance Server
	${ACCEPTANCE} ps