Makefile

.PHONY: release-dev release-patch release-minor release-major help docs pubdocs do-release requirements
.DEFAULT_GOAL := help

RELEASE_KIND := patch
BRANCH_NAME := $(shell echo $$(git rev-parse --abbrev-ref HEAD))
SHORT_BRANCH_NAME := $(shell echo $(BRANCH_NAME) | cut -c 1-20)
PRIMARY_BRANCH_NAME := master
BUMPVERSION_OPTS :=
EDIT_CHANGELOG := $(shell if [[ -n $$EDITOR ]] ; then echo "$$EDITOR CHANGELOG.md" ; else echo "true" ; fi)

help:
	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'

release-dev: RELEASE_KIND := dev
release-dev: do-release  ## Release a new development version: 1.1.1 -> 1.1.1+branchname-1

release-patch: RELEASE_KIND := patch
release-patch: do-release  ## Release a new patch version: 1.1.1 -> 1.1.2

release-minor: RELEASE_KIND := minor
release-minor: do-release  ## Release a new minor version: 1.1.1 -> 1.2.0

release-major: RELEASE_KIND := major
release-major: do-release  ## Release a new major version: 1.1.1 -> 2.0.0

release-version: get-version do-release  ## Release a specific version: release-version 1.2.3

docs: ## generate Sphinx HTML documentation, including API docs
	mkdir -p docs
	rm -rf docsrc/_autosummary
	ls -A1 docs | xargs -I {} rm -rf docs/{}
	$(MAKE) -C docsrc clean html
	cp -a docsrc/_build/html/. docs

pubdocs: docs ## Publish the documentation to GitHub
	ghp-import -op docs

#
# Helper targets. Not meant to use directly
#

do-release:
	@if [[ "$(BRANCH_NAME)" == "$(PRIMARY_BRANCH_NAME)" ]]; then \
		if [[ "$(RELEASE_KIND)" == "dev" ]]; then \
			echo "Error! Can't bump $(RELEASE_KIND) while on the $(PRIMARY_BRANCH_NAME) branch."; \
			exit; \
		fi; \
	elif [[ "$(RELEASE_KIND)" != "dev" ]]; then \
		echo "Error! Must be on the $(PRIMARY_BRANCH_NAME) branch to bump $(RELEASE_KIND)."; \
		exit; \
	fi; \
	git fetch -p --all; \
	generate-changelog; \
	$(call EDIT_CHANGELOG); \
	./tools/gen-codeowners.sh $(SOURCE_DIR); \
	git add CODEOWNERS; \
	export BRANCH_NAME=$(SHORT_BRANCH_NAME);bumpversion $(BUMPVERSION_OPTS) $(RELEASE_KIND) --allow-dirty; \
	git push origin $(BRANCH_NAME); \
	git push --tags;

get-version:  # Sets the value after release-version to the VERSION
	$(eval VERSION := $(filter-out release-version,$(MAKECMDGOALS)))
	$(eval BUMPVERSION_OPTS := --new-version=$(VERSION))

requirements: # Write all the requirements to requirements/*.txt
	rm requirements/*.txt
	pip-compile --quiet -o requirements/prod.txt pyproject.toml
	pip-compile --quiet --extra=test -o requirements/test.txt pyproject.toml
	pip-compile --quiet --extra=docs -o requirements/docs.txt pyproject.toml
	pip-compile --quiet --extra=docs --extra=test --extra=dev -o requirements/dev.txt pyproject.toml


%: # NO-OP for unrecognized rules
	@: