mirror of
https://github.com/timmypidashev/web.git
synced 2026-04-14 19:13:51 +00:00
187 lines
8.2 KiB
Makefile
187 lines
8.2 KiB
Makefile
PROJECT_NAME := "web"
|
|
PROJECT_AUTHORS := "Timothy Pidashev (timmypidashev) <pidashev.tim@gmail.com>"
|
|
PROJECT_VERSION := "v1.0.1"
|
|
PROJECT_LICENSE := "MIT"
|
|
PROJECT_SOURCES := "https://github.com/timmypidashev/web"
|
|
PROJECT_REGISTRY := "ghcr.io/timmypidashev/web"
|
|
PROJECT_ORGANIZATION := "org.opencontainers"
|
|
|
|
CONTAINER_WEB_NAME := "web"
|
|
CONTAINER_WEB_VERSION := "v1.0.0"
|
|
CONTAINER_WEB_LOCATION := "src/"
|
|
CONTAINER_WEB_DESCRIPTION := "My portfolio website!"
|
|
|
|
.DEFAULT_GOAL := help
|
|
.PHONY: run build push prune bump
|
|
.SILENT: run build push prune bump
|
|
|
|
help:
|
|
@echo "Available targets:"
|
|
@echo " run - Runs the docker compose file with the specified environment (dev or release)"
|
|
@echo " build - Builds the specified docker image with the appropriate environment"
|
|
@echo " push - Pushes the built docker image to the registry"
|
|
@echo " prune - Removes all built and cached docker images and containers"
|
|
@echo " bump - Bumps the project and container versions"
|
|
|
|
run:
|
|
# Arguments:
|
|
# [environment]: 'dev' or 'release'
|
|
#
|
|
# Explanation:
|
|
# * Runs the docker compose file with the specified environment(compose.dev.yml, or compose.release.yml)
|
|
# * Passes all generated arguments to the compose file.
|
|
|
|
# Make sure we have been given proper arguments.
|
|
@if [ "$(word 2,$(MAKECMDGOALS))" = "dev" ]; then \
|
|
echo "Running in development environment"; \
|
|
elif [ "$(word 2,$(MAKECMDGOALS))" = "release" ]; then \
|
|
echo "Running in release environment"; \
|
|
else \
|
|
echo "Invalid usage. Please use 'make run dev' or 'make run release'"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
docker compose -f compose.$(word 2,$(MAKECMDGOALS)).yml up --remove-orphans
|
|
|
|
|
|
build:
|
|
# Arguments
|
|
# [container]: Build context(which container to build ['all' to build every container defined])
|
|
# [environment]: 'dev' or 'release'
|
|
#
|
|
# Explanation:
|
|
# * Builds the specified docker image with the appropriate environment.
|
|
# * Passes all generated arguments to docker build-kit.
|
|
|
|
# Extract container and environment inputted.
|
|
$(eval INPUT_TARGET := $(word 2,$(MAKECMDGOALS)))
|
|
$(eval INPUT_CONTAINER := $(firstword $(subst :, ,$(INPUT_TARGET))))
|
|
$(eval INPUT_ENVIRONMENT := $(lastword $(subst :, ,$(INPUT_TARGET))))
|
|
|
|
# Call function container_build either through a for loop for each container
|
|
# if all is called, or singularly to build the container.
|
|
$(if $(filter $(strip $(INPUT_CONTAINER)),all), \
|
|
$(foreach container,$(containers),$(call container_build,$(container) $(INPUT_ENVIRONMENT))), \
|
|
$(call container_build,$(INPUT_CONTAINER) $(INPUT_ENVIRONMENT)))
|
|
|
|
push:
|
|
# Arguments
|
|
# [container]: Push context(which container to push to the registry)
|
|
# [version]: Container version to push.
|
|
#
|
|
# Explanation:
|
|
# * Pushes the specified container version to the registry defined in the user configuration.
|
|
|
|
# Extract container and version inputted.
|
|
$(eval INPUT_TARGET := $(word 2,$(MAKECMDGOALS)))
|
|
$(eval INPUT_CONTAINER := $(firstword $(subst :, ,$(INPUT_TARGET))))
|
|
$(eval INPUT_VERSION := $(lastword $(subst :, ,$(INPUT_TARGET))))
|
|
|
|
# Push the specified container version to the registry.
|
|
# NOTE: docker will complain if the container tag is invalid, no need to validate here.
|
|
@docker push $(PROJECT_REGISTRY)/$(INPUT_CONTAINER):$(INPUT_VERSION)
|
|
|
|
prune:
|
|
# Removes all built and cached docker images and containers.
|
|
|
|
bump:
|
|
# Arguments
|
|
# [container]: Bump context(which container version to bump)
|
|
# [semantic_type]: Semantic type context(major, minor, patch)
|
|
#
|
|
# Explanation:
|
|
# * Bumps the specified container version within the makefile config and the container's package.json.
|
|
# * Bumps the global project version in the makefile, and creates a new git tag with said version.
|
|
|
|
# Extract container and semantic_type inputted.
|
|
$(eval INPUT_TARGET := $(word 2,$(MAKECMDGOALS)))
|
|
$(eval INPUT_CONTAINER := $(firstword $(subst :, ,$(INPUT_TARGET))))
|
|
$(eval INPUT_SEMANTIC_TYPE := $(lastword $(subst :, ,$(INPUT_TARGET))))
|
|
|
|
# Extract old container and project versions.
|
|
$(eval OLD_CONTAINER_VERSION := $(subst v,,$(CONTAINER_$(shell echo $(INPUT_CONTAINER) | tr a-z A-Z)_VERSION)))
|
|
$(eval OLD_PROJECT_VERSION := $(subst v,,$(PROJECT_VERSION)))
|
|
|
|
# Pull docker semver becsause the normal command doesn't seem to work; also we don't need to worry about dependencies.
|
|
docker pull usvc/semver:latest
|
|
|
|
# Bump npm package.json file for selected container
|
|
cd $(call container_location,$(INPUT_CONTAINER)) && npm version $(shell docker run usvc/semver:latest bump $(INPUT_SEMANTIC_TYPE) $(OLD_CONTAINER_VERSION))
|
|
|
|
# Bump the git tag to match the new global version
|
|
git tag v$(shell docker run usvc/semver:latest bump $(INPUT_SEMANTIC_TYPE) $(OLD_PROJECT_VERSION))
|
|
|
|
# Bump the container version and global version in the Makefile
|
|
perl -pi -e 's/^PROJECT_VERSION\s*:=\s*\K.*/"v$(shell docker run usvc/semver:latest bump $(INPUT_SEMANTIC_TYPE) $(OLD_PROJECT_VERSION))"/ if /^PROJECT_VERSION\s*:=/' Makefile;
|
|
perl -pi -e 's/^CONTAINER_$(shell echo $(INPUT_CONTAINER) | tr a-z A-Z)_VERSION\s*:=\s*\K.*/"v$(shell docker run usvc/semver:latest bump $(INPUT_SEMANTIC_TYPE) $(OLD_CONTAINER_VERSION))"/ if /^CONTAINER_$(shell echo $(INPUT_CONTAINER) | tr a-z A-Z)_VERSION\s*:=/' Makefile;
|
|
|
|
# This function generates Docker build arguments based on variables defined in the Makefile.
|
|
# It extracts variable assignments, removes whitespace, and formats them as build arguments.
|
|
# Additionally, it appends any custom shell generated arguments defined below.
|
|
define args
|
|
$(shell \
|
|
grep -E '^[[:alnum:]_]+[[:space:]]*[:?]?[[:space:]]*=' $(MAKEFILE_LIST) | \
|
|
awk 'BEGIN {FS = ":="} { \
|
|
gsub(/^[[:space:]]+|[[:space:]]+$$/, "", $$2); \
|
|
gsub(/^/, "\x27", $$2); \
|
|
gsub(/$$/, "\x27", $$2); \
|
|
gsub(/[[:space:]]+/, "", $$1); \
|
|
gsub(":", "", $$1); \
|
|
printf "--build-arg %s=%s ", $$1, $$2 \
|
|
}') \
|
|
--build-arg BUILD_DATE='"$(shell date)"' \
|
|
--build-arg GIT_COMMIT='"$(shell git rev-parse HEAD)"'
|
|
endef
|
|
|
|
# This function generates labels based on variables defined in the Makefile.
|
|
# It extracts only the selected container variables and is used to echo this information
|
|
# to the docker buildx engine in the command line.
|
|
define labels
|
|
--label $(PROJECT_ORGANIZATION).image.title=$(CONTAINER_$(1)_NAME) \
|
|
--label $(PROJECT_ORGANIZATION).image.description=$(CONTAINER_$(1)_DESCRIPTION) \
|
|
--label $(PROJECT_ORGANIZATION).image.authors=$(PROJECT_AUTHORS) \
|
|
--label $(PROJECT_ORGANIZATION).image.url=$(PROJECT_SOURCES) \
|
|
--label $(PROJECT_ORGANIZATION).image.source=$(PROJECT_SOURCES)/$(CONTAINER_$(1)_LOCATION)
|
|
endef
|
|
|
|
# This function returns a list of container names defined in the Makefile.
|
|
# In order for this function to return a container, it needs to have this format: CONTAINER_%_NAME!
|
|
define containers
|
|
$(strip $(filter-out $(_NL),$(foreach var,$(.VARIABLES),$(if $(filter CONTAINER_%_NAME,$(var)),$(strip $($(var)))))))
|
|
endef
|
|
|
|
define container_build
|
|
$(eval CONTAINER := $(word 1,$1))
|
|
$(eval ENVIRONMENT := $(word 2,$1))
|
|
$(eval ARGS := $(shell echo $(args)))
|
|
$(eval VERSION := $(strip $(call container_version,$(CONTAINER))))
|
|
$(eval TAG := $(CONTAINER):$(ENVIRONMENT))
|
|
|
|
@echo "Building container: $(CONTAINER)"
|
|
@echo "Environment: $(ENVIRONMENT)"
|
|
@echo "Version: $(VERSION)"
|
|
|
|
@if [ "$(strip $(ENVIRONMENT))" != "dev" ] && [ "$(strip $(ENVIRONMENT))" != "release" ]; then \
|
|
echo "Invalid environment. Please specify 'dev' or 'release'"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
$(if $(filter $(strip $(ENVIRONMENT)),release), \
|
|
$(eval TAG := $(PROJECT_REGISTRY)/$(CONTAINER):$(VERSION)), \
|
|
)
|
|
|
|
docker buildx build --load -t $(TAG) -f .docker/Dockerfile.$(ENVIRONMENT) ./$(strip $(subst $(SPACE),,$(call container_location,$(CONTAINER))))/. $(ARGS) $(call labels,$(shell echo $(CONTAINER_NAME) | tr '[:lower:]' '[:upper:]')) --no-cache
|
|
endef
|
|
|
|
define container_location
|
|
$(strip $(eval CONTAINER_NAME := $(shell echo $(1) | tr '[:lower:]' '[:upper:]'))) \
|
|
$(CONTAINER_$(CONTAINER_NAME)_LOCATION)
|
|
endef
|
|
|
|
define container_version
|
|
$(strip $(eval CONTAINER_NAME := $(shell echo $(1) | tr '[:lower:]' '[:upper:]'))) \
|
|
$(if $(CONTAINER_$(CONTAINER_NAME)_VERSION), \
|
|
$(shell echo $(strip $(strip $(CONTAINER_$(CONTAINER_NAME)_VERSION))) | tr -d '[:space:]'), \
|
|
$(error Version data for container $(1) not found))
|
|
endef
|