Makefile

####################################################################################
# Makefile (configuration file for GNU make - see http://www.gnu.org/software/make/)
# Time-stamp: <Tue 2021-02-16 13:27 svarrette>
#     __  __       _         __ _ _
#    |  \/  | __ _| | _____ / _(_) | ___
#    | |\/| |/ _` | |/ / _ \ |_| | |/ _ \
#    | |  | | (_| |   <  __/  _| | |  __/
#    |_|  |_|\__,_|_|\_\___|_| |_|_|\___|
#
# Copyright (c) 2012 Sebastien Varrette <Sebastien.Varrette@uni.lu>
# .             http://varrette.gforge.uni.lu
#
####################################################################################
#
############################## Variables Declarations ##############################
SHELL = /bin/bash

UNAME = $(shell uname)

# Some directories
SUPER_DIR   = $(shell basename `pwd`)

XDG_CACHE_HOME  ?= $(HOME)/.cache
XDG_CONFIG_HOME ?= $(HOME)/.config
XDG_DATA_HOME   ?= $(HOME)/.local/share

# Git stuff management
HAS_GITFLOW      = $(shell git flow version 2>/dev/null || [ $$? -eq 0 ])
LAST_TAG_COMMIT = $(shell git rev-list --tags --max-count=1)
LAST_TAG = $(shell git describe --tags $(LAST_TAG_COMMIT) )
TAG_PREFIX = "v"
# GITFLOW_BR_MASTER  = $(shell git config --get gitflow.branch.master)
# GITFLOW_BR_DEVELOP = $(shell git config --get gitflow.branch.develop)
GITFLOW_BR_MASTER=production
GITFLOW_BR_DEVELOP=devel

CURRENT_BRANCH          = $(shell git rev-parse --abbrev-ref HEAD)
GIT_BRANCHES            = $(shell git for-each-ref --format='%(refname:short)' refs/heads/ | xargs echo)
GIT_REMOTES             = $(shell git remote | xargs echo )
GIT_ROOTDIR             = $(shell git rev-parse --show-toplevel)
GIT_HOOKSDIR            = .git/hooks
SRC_HOOKSDIR            = config/hooks
#SRC_HOOKSDIR_TO_ROOTDIR = $(shell git -C "$(GIT_ROOTDIR)/$(SRC_HOOKSDIR)" rev-parse --show-cdup)
SRC_PRECOMMIT_HOOK      = $(wildcard $(SRC_HOOKSDIR)/pre-commit*.sh)

GIT_DIRTY    = $(shell git diff --shortstat 2> /dev/null | tail -n1 )
# Git subtrees repositories
# Format: '<url>[|<branch>]' - don't forget the quotes. if branch is ignored, 'master' is used
#GIT_SUBTREE_REPOS = 'https://github.com/ULHPC/easybuild-framework.git|develop'  \
					 'https://github.com/hpcugent/easybuild-wiki.git'
GITSTATS     = ./.submodules/gitstats/gitstats
GITSTATS_DIR = gitstats
# Below variable is used to sanitize stats by defining the (lowercase) strings to be
# substituted to aggregate stats from the same author (eventually using different mails)
# Ex: GITSTATS_SUBSTITUTE_PATTERN_CMD="sed -e 's/<old1>/<new1>/' -e 's/<old2>/<new2>'" 
GITSTATS_SUBSTITUTE_PATTERN_CMD=sed -e '\#'

# Branches to update on 'make up'
GIT_BRANCHES_TO_UPDATE = $(GITFLOW_BR_DEVELOP) $(GITFLOW_BR_MASTER)

ifeq (,$(wildcard .bumpversion.cfg))
VERSION  = $(shell [ -f VERSION ] && head VERSION || echo '0.0.1')
else
VERSION = $(shell bumpversion --dry-run --allow-dirty --list minor | grep current_version | cut -d '=' -f 2)
endif

# OR try to guess directly from the last git tag
#VERSION    = $(shell  git describe --tags $(LAST_TAG_COMMIT) | sed "s/^$(TAG_PREFIX)//")
MAJOR      = $(shell echo $(VERSION) | sed "s/^\([0-9]*\).*/\1/")
MINOR      = $(shell echo $(VERSION) | sed "s/[0-9]*\.\([0-9]*\).*/\1/")
PATCH      = $(shell echo $(VERSION) | sed "s/[0-9]*\.[0-9]*\.\([0-9]*\).*/\1/")
# total number of commits
BUILD      = $(shell git log --oneline | wc -l | sed -e "s/[ \t]*//g")
#REVISION   = $(shell git rev-list $(LAST_TAG).. --count)
ifeq (,$(wildcard .bumpversion.cfg))
NEXT_MAJOR_VERSION = $(shell expr $(MAJOR) + 1).0.0-b$(BUILD)
NEXT_MINOR_VERSION = $(MAJOR).$(shell expr $(MINOR) + 1).0-b$(BUILD)
NEXT_PATCH_VERSION = $(MAJOR).$(MINOR).$(shell expr $(PATCH) + 1)-b$(BUILD)
else
NEXT_MAJOR_VERSION = $(shell expr $(MAJOR) + 1).0.0
NEXT_MINOR_VERSION = $(MAJOR).$(shell expr $(MINOR) + 1).0
NEXT_PATCH_VERSION = $(MAJOR).$(MINOR).$(shell expr $(PATCH) + 1)
endif

# Python stuff
# See https://pip.pypa.io/en/stable/user_guide/#requirements-files
PIP_REQUIREMENTS_FILE = requirements.txt

##################### Main targets #####################
# Default targets - append your own with TARGETS += <xXx>
TARGETS =
# Default targets for 'make [dist]clean' - append your own with [DIST]CLEAN_TARGETS += [dist]clean-<xXx>
CLEAN_TARGETS = clean-gitstats
DISTCLEAN_TARGETS =
# Default targets for 'make setup' - append your own with SETUP_TARGETS += setup-<xXx>
SETUP_TARGETS = setup-git setup-gitflow setup-submodules setup-subtrees setup-githooks
# Default targets for 'make git-clone'. To append your own:
#   Define
GIT_CLONE_TARGETS =


################### Custom Makefile  ###################
# Local configuration - Kept for compatibity reason
LOCAL_MAKEFILE  = .Makefile.local

# Makefile custom hooks
MAKEFILE_CUSTOM = .Makefile.custom
MAKEFILE_BEFORE = .Makefile.before
MAKEFILE_AFTER  = .Makefile.after

### Main variables
.PHONY: all info archive clean help release start_bump_major start_bump_minor start_bump_patch subtree_setup subtree_up subtree_diff  upgrade versioninfo doc

############################### Now starting rules ################################
# Load local settings, if existing (to override variable eventually)
ifneq (,$(wildcard $(LOCAL_MAKEFILE)))
include $(LOCAL_MAKEFILE)
endif
ifneq (,$(wildcard $(MAKEFILE_BEFORE)))
include $(MAKEFILE_BEFORE)
endif
ifneq (,$(wildcard $(MAKEFILE_CUSTOM)))
include $(MAKEFILE_CUSTOM)
endif

### Below default could be set in .Makefile.{local,before}
# Default python virtualenv - by default under venv/$(basename <dir>)
PYTHON_VENV_DIR ?= venv
PYTHON_VENV     ?= $(SUPER_DIR)
# Default Git clone parameters (url, target path for the working directory)
PYENV_GIT_REPO_URL            ?= https://github.com/pyenv/pyenv.git
PYENV_GIT_REPO                ?= $(XDG_DATA_HOME)/pyenv
PYENV_VIRTUALENV_GIT_REPO_URL ?= https://github.com/pyenv/pyenv-virtualenv.git
PYENV_VIRTUALENV_GIT_REPO     ?= $(XDG_DATA_HOME)/pyenv/plugins/pyenv-virtualenv

# Required rule : what's to be done each time
all: $(TARGETS)

# Test values of variables - for debug purposes
info:
	@echo "--- Compilation commands --- "
	@echo "HAS_GITFLOW      -> '$(HAS_GITFLOW)'"
	@echo "--- Directories --- "
	@echo "SUPER_DIR       -> '$(SUPER_DIR)'"
	@echo "XDG_CONFIG_HOME -> '$(XDG_CONFIG_HOME)'"
	@echo "XDG_CACHE_HOME  -> '$(XDG_CACHE_HOME)'"
	@echo "XDG_DATA_HOME   -> '$(XDG_DATA_HOME)'"
	@echo "--- Git stuff ---"
	@echo "GIT_ROOTDIR            -> '$(GIT_ROOTDIR)'"
	@echo "GITFLOW                -> '$(GITFLOW)'"
	@echo "GITFLOW_BR_MASTER      -> '$(GITFLOW_BR_MASTER)'"
	@echo "GITFLOW_BR_DEVELOP     -> '$(GITFLOW_BR_DEVELOP)'"
	@echo "CURRENT_BRANCH         -> '$(CURRENT_BRANCH)'"
	@echo "GIT_BRANCHES           -> '$(GIT_BRANCHES)'"
	@echo "GIT_REMOTES            -> '$(GIT_REMOTES)'"
	@echo "GIT_DIRTY              -> '$(GIT_DIRTY)'"
	@echo "GIT_SUBTREE_REPOS      -> '$(GIT_SUBTREE_REPOS)'"
	@echo "GIT_BRANCHES_TO_UPDATE -> '$(GIT_BRANCHES_TO_UPDATE)'"
	@echo "GIT_HOOKSDIR           -> '$(GIT_HOOKSDIR)'"
	@echo "SRC_HOOKSDIR           -> '$(SRC_HOOKSDIR)'"
	@echo "SRC_HOOKSDIR_TO_ROOTDIR-> '$(SRC_HOOKSDIR_TO_ROOTDIR)'"
	@echo "SRC_PRECOMMIT_HOOK     -> '$(SRC_PRECOMMIT_HOOK)'"
	@echo "--- Python stuff ---"
	@echo "PYTHON_VENV_DIR        -> '${PYTHON_VENV_DIR}'"
	@echo "PYTHON_VENV            -> '${PYTHON_VENV}'"
	@echo "PYENV_GIT_REPO_URL     -> '${PYENV_GIT_REPO_URL}'"
	@echo "PYENV_GIT_REPO         -> '${PYENV_GIT_REPO}'"
	@echo "PYENV_VIRTUALENV_GIT_REPO_URL -> '${PYENV_VIRTUALENV_GIT_REPO_URL}'"
	@echo "PYENV_VIRTUALENV_GIT_REPO     -> '${PYENV_VIRTUALENV_GIT_REPO}'"
	@echo ""
	@echo "Consider running 'make versioninfo' to get info on git versionning variables"

############################### Archiving ################################
archive: clean
	tar -C ../ -cvzf ../$(SUPER_DIR)-$(VERSION).tar.gz --exclude ".svn" --exclude ".git"  --exclude "*~" --exclude ".DS_Store" $(SUPER_DIR)/

############################### Git Bootstrapping rules ################################
.PHONE: setup setup-git setup-gitflow setup-xdg setup-git-lfs
setup: $(SETUP_TARGETS)
	@if [ -d "$(GIT_ROOTDIR)/$(SRC_HOOKSDIR)" ]; then \
		echo "=> setup local git hooks"; \
		$(MAKE) setup_git_hooks; \
	fi
	@if [ -f .gitattributes ] && [ -n "$(shell grep '=lfs' .gitattributes)" ]; then \
		echo "=> setup git-lfs"; \
		$(MAKE) setup-git-lfs; \
	fi
	@if [ -f .envrc ]; then \
		$(MAKE) setup-direnv; \
	fi

setup-git:
	-git fetch origin
	-git branch --track $(GITFLOW_BR_MASTER) origin/$(GITFLOW_BR_MASTER)

setup-gitflow:
	git config gitflow.branch.master     $(GITFLOW_BR_MASTER)
	git config gitflow.branch.develop    $(GITFLOW_BR_DEVELOP)
	git config gitflow.prefix.feature    feature/
	git config gitflow.prefix.release    release/
	git config gitflow.prefix.hotfix     hotfix/
	git config gitflow.prefix.support    support/
	git config gitflow.prefix.versiontag $(TAG_PREFIX)

setup-submodules:
	-$(MAKE) update

setup-subtrees:
	$(if $(GIT_SUBTREE_REPOS), $(MAKE) subtree_setup)

setup-githooks:
	@if [ -d "$(GIT_ROOTDIR)/$(SRC_HOOKSDIR)" ]; then \
		echo "=> setup local git hooks"; \
		$(MAKE) _setup_git_hooks; \
	fi

_setup_git_hooks:
	@if [ -n "$(SRC_PRECOMMIT_HOOK)" ]; then \
		if [ -f "$(GIT_ROOTDIR)/$(SRC_PRECOMMIT_HOOK)" ] && [ ! -f "$(GIT_ROOTDIR)/$(GIT_HOOKSDIR)/pre-commit" ]; then \
			echo "=> setup Git pre-commit hook"; \
			ln -s ../../$(SRC_PRECOMMIT_HOOK) $(GIT_ROOTDIR)/$(GIT_HOOKSDIR)/pre-commit; \
		fi ; \
	fi

ifneq (,$(shell which git-lfs 2>/dev/null))
setup-git-lfs:
	git-lfs pull
else
setup-git-lfs:
	@echo "*** ERROR *** git-lfs extension not found on your system"
	@echo "              install it (see https://git-lfs.github.com/) and run "
	@echo "        make $@"
endif

setup-xdg:
	@echo "=> setup XDG Base Directories"
	mkdir -p $(XDG_CONFIG_HOME)
	mkdir -p $(XDG_DATA_HOME)
	mkdir -p $(XDG_CACHE_HOME)

define __SHELL_PROFILE_SOURCE_IF_PRESENT

# Add the following to your favorite shell config (~/.bashrc or ~/.zshrc etc.)
if [ -f "$1" ]; then
	. $1
fi

endef
.PHONY: setup-shell-direnv setup-shell-pyenv
setup-shell-direnv:
	$(info $(call __SHELL_PROFILE_SOURCE_IF_PRESENT,$(XDG_CONFIG_HOME)/direnv/init.sh))
setup-shell-pyenv:
	$(info $(call __SHELL_PROFILE_SOURCE_IF_PRESENT,$(XDG_CONFIG_HOME)/pyenv/init.sh))


# --- Direnv
.PHONY: setup-direnv setup-pyenv setup-venv setup-python
setup-direnv: setup-xdg
	@echo "=> setup direnv -- see https://varrette.gforge.uni.lu/tutorials/pyenv.html"
	mkdir -p $(XDG_CONFIG_HOME)/direnv
	@if [ ! -f "$(XDG_CONFIG_HOME)/direnv/init.sh" ]; then \
		echo " - creating $(XDG_CONFIG_HOME)/direnv/init.sh"; \
		curl -o $(XDG_CONFIG_HOME)/direnv/init.sh https://raw.githubusercontent.com/Falkor/dotfiles/master/shell/available/direnv.sh; \
	fi
	@echo " - sample override of direnv-stdlib in $(XDG_CONFIG_HOME)/direnv/direnvrc"
	@if [ ! -f "$(XDG_CONFIG_HOME)/direnv/direnvrc" ]; then \
		curl -o $(XDG_CONFIG_HOME)/direnv/direnvrc https://raw.githubusercontent.com/Falkor/dotfiles/master/direnv/direnvrc; \
	fi
	@echo " - sample '.envrc' for your projects in  $(XDG_CONFIG_HOME)/direnv/envrc"
	@if [ ! -f "$(XDG_CONFIG_HOME)/direnv/envrc" ]; then \
		curl -o $(XDG_CONFIG_HOME)/direnv/envrc https://raw.githubusercontent.com/Falkor/dotfiles/master/direnv/envrc; \
	fi
	@$(MAKE) setup-shell-direnv

# --- pyenv
setup-pyenv: setup-xdg git-clone-pyenv git-clone-pyenv-virtualenv
	@echo "=> setup pyenv -- see https://varrette.gforge.uni.lu/tutorials/pyenv.html"
	mkdir -p $(XDG_CONFIG_HOME)/pyenv
	@if [ ! -f "$(XDG_CONFIG_HOME)/pyenv/init.sh" ]; then \
		echo " - creating $(XDG_CONFIG_HOME)/pyenv/init.sh"; \
		curl -o $(XDG_CONFIG_HOME)/pyenv/init.sh https://raw.githubusercontent.com/Falkor/dotfiles/master/shell/available/pyenv.sh; \
	fi
	@$(MAKE) setup-shell-pyenv

# --- venv
setup-venv:
	python3 -m venv $(PYTHON_VENV_DIR)/$(PYTHON_VENV)

# --- python
ifneq (,$(wildcard ./$(PIP_REQUIREMENTS_FILE)))
setup-python:
	@echo "=> updating pip version"
	pip install --upgrade pip
	@echo "=> installing Python dependencies from Requirements files '$(PIP_REQUIREMENTS_FILE)'"
	pip install -r $(PIP_REQUIREMENTS_FILE)
else
setup-python:
	@echo "=> updating pip version"
	pip install --upgrade pip
endif



### Git clone
#######
# Usage: $(eval $(call __GIT_CLONE,<suffix>,<path>,<url>))
##
define __GIT_CLONE
.PHONY: git-clone-$1
git-clone-$1:
	@if [ ! -d "$2" ]; then \
		mkdir -p $(shell dirname $2); \
		echo "=> cloning '$3' into $2"; \
		git clone $3 $2; \
	else \
		echo "... existing directory '$2', thus exiting"; \
	fi
GIT_CLONE_TARGETS += git-clone-$1
endef
$(eval $(call __GIT_CLONE,pyenv,$(PYENV_GIT_REPO),$(PYENV_GIT_REPO_URL)))
$(eval $(call __GIT_CLONE,pyenv-virtualenv,$(PYENV_VIRTUALENV_GIT_REPO),$(PYENV_VIRTUALENV_GIT_REPO_URL)))

fetch:
	git fetch --all -v

versioninfo:
	@echo "Current version: $(VERSION)"
	@echo "Last tag: $(LAST_TAG)"
	@echo "$(shell git rev-list $(LAST_TAG).. --count) commit(s) since last tag"
	@echo "Build: $(BUILD) (total number of commits)"
	@echo "next major version: $(NEXT_MAJOR_VERSION)"
	@echo "next minor version: $(NEXT_MINOR_VERSION)"
	@echo "next patch version: $(NEXT_PATCH_VERSION)"

### Git flow management
ifeq ($(HAS_GITFLOW),)
start_bump_patch start_bump_minor start_bump_major release:
	@echo "Unable to find git-flow on your system. "
	@echo "See https://github.com/nvie/gitflow for installation details"
else

define __VERSION_BUMP
start_bump_$1:
	$$(if $$(GIT_DIRTY), $$(error "Unable to bump version: Dirty Git repository"))
	@echo "Start the '$1' release of the repository from $$(VERSION) to $2"
	git pull origin
	git flow release start $2
	@sleep 1
	@if [ -f VERSION ]; then \
		echo $2 > VERSION; \
		git commit -s -m "$1 bump to version $2" VERSION; \
	fi
	@if [ -f .bumpversion.cfg ]; then \
		echo "=> using 'bumpversion [...] $1'"; \
		bumpversion --commit --no-tag $1; \
	fi
	@echo "=> run 'make release' once you finished the bump"
endef

$(eval $(call __VERSION_BUMP,patch,$(NEXT_PATCH_VERSION)))
$(eval $(call __VERSION_BUMP,minor,$(NEXT_MINOR_VERSION)))
$(eval $(call __VERSION_BUMP,major,$(NEXT_MAJOR_VERSION)))

release: clean
	@if [ -f .bumpversion.cfg ]; then \
		echo "=> release using 'bumpversion [...] release'"; \
		bumpversion --commit --no-tag release; \
	fi
	git flow release finish -s $(VERSION:%rc=%)
	git checkout $(GITFLOW_BR_MASTER)
	git push origin
	git checkout $(GITFLOW_BR_DEVELOP)
	git push origin
	git push origin --tags
endif

### Git (submodule|branch)  management: pull and upgrade to the latest version
up update:
	$(if $(GIT_DIRTY), $(error "Unable to pull latest commits: Dirty Git repository"))
	@for br in $(GIT_BRANCHES_TO_UPDATE); do \
		echo -e "\n=> Pulling and updating the local branch '$$br'\n"; \
		git checkout $$br; \
		git pull origin $$br; \
	done
	git checkout $(CURRENT_BRANCH)
	@echo "=> updating (NOT upgrading) git submodule"
	git submodule init
	git submodule update

### Git submodule upgrade
upgrade: update
	git submodule foreach 'git fetch origin; git checkout $$(git rev-parse --abbrev-ref HEAD); git reset --hard origin/$$(git rev-parse --abbrev-ref HEAD); git submodule update --recursive; git clean -dfx'
	-@for submoddir in $(shell git submodule status | awk '{ print $$2 }' | xargs echo); do \
		git commit -s -m "Upgrading Git submodule '$$submoddir' to the latest version" $$submoddir || true;\
	done


### Git subtree management
ifeq ($(GIT_SUBTREE_REPOS),)
subtree_setup subtree_diff subtree_up:
	@echo "no repository configured in GIT_SUBTREE_REPOS..."
else
subtree_setup:
	@for elem in $(GIT_SUBTREE_REPOS); do \
		url=`echo $$elem | cut -d '|' -f 1`; \
		repo=`basename $$url .git`; \
		if [[ ! "$(GIT_REMOTES)" =~ "$$repo"  ]]; then \
			echo "=> initializing Git remote '$$repo'"; \
			git remote add -f $$repo $$url; \
		fi \
	done

subtree_diff:
	@for elem in $(GIT_SUBTREE_REPOS); do \
		url=`echo $$elem | cut -d '|' -f 1`; \
		repo=`basename $$url .git`; \
		path=`echo $$repo | tr '-' '/'`; \
		br=`echo $$elem | cut -d '|' -f 2`;  \
		[ "$$br" == "$$url" ] && br='master'; \
		echo -e "\n============ diff on subtree '$$path' with remote '$$repo/$$br' ===========\n"; \
		git diff $${repo}/$$br $(CURRENT_BRANCH):$$path; \
	done

subtree_up:
	$(if $(GIT_DIRTY), $(error "Unable to pull subtree(s): Dirty Git repository"))
	@for elem in $(GIT_SUBTREE_REPOS); do \
		url=`echo $$elem | cut -d '|' -f 1`; \
		repo=`basename $$url .git`; \
		path=`echo $$repo | tr '-' '/'`; \
		br=`echo $$elem | cut -d '|' -f 2`;  \
		[ "$$br" == "$$url" ] && br='master'; \
		echo -e "\n===> pulling changes into subtree '$$path' using remote '$$repo/$$br'"; \
		echo -e "     \__ fetching remote '$$repo'"; \
		git fetch $$repo; \
		echo -e "     \__ pulling changes"; \
		git subtree pull --prefix $$path --squash $${repo} $${br}; \
	done
endif


### [Dist]Clean option
clean: $(CLEAN_TARGETS)
distclean: $(DISTCLEAN_TARGETS)

clean-gitstats:
	@if [ -d "$(GITSTATS_DIR)" ]; then \
		echo "==> removing '$(GITSTATS_DIR)' directory"; \
		rm -rf $(GITSTATS_DIR); \
	fi

# Perform various git statistics
stats:
	@if [ ! -d $(GITSTATS_DIR) ]; then mkdir -p $(GITSTATS_DIR); fi
	@if [ -x "$(GITSTATS)" ]; then $(GITSTATS) . $(GITSTATS_DIR)/; fi
	@echo "=> Git commits (based on 'git log --pretty=\"%al\")"
	@git log --pretty="%al" | tr '[A-Z]' '[a-z]' | $(GITSTATS_SUBSTITUTE_PATTERN_CMD) | tr '.' ' ' | awk '{print toupper(substr($$0,1,1))substr($$1,2),toupper(substr($$2,1,1))substr($$2,2)}' | sort | uniq -c | sort -r
#        left part mail     force lowercase      replace .    capitalize $1 $1 (doubling $)
doc:
	@if [ -n "`which mkdocs`" ]; then \
		mkdocs serve; \
	fi


# print help message
help :
	@echo '+----------------------------------------------------------------------+'
	@echo '|                        Available Commands                            |'
	@echo '+----------------------------------------------------------------------+'
	@echo '| make setup:   Initiate git-flow for your local copy of the repository|'
	@echo '| make start_bump_{major,minor,patch}: start a new version release with|'
	@echo '|               git-flow at a given level (major, minor or patch bump) |'
	@echo '| make release: Finalize the release using git-flow                    |'
	@echo '+----------------------------------------------------------------------+'


ifneq (,$(wildcard $(MAKEFILE_AFTER)))
include $(MAKEFILE_AFTER)
endif