Makefile

.DEFAULT_GOAL := help

CI_CONFIG_YAML=ci-config.yaml
CI_CONFIG_ABSOLUTE_YAML=ci-config-absolute.yaml
DEV_CONFIG_YAML=dev-config.yaml
DEV_CONFIG_ABSOLUTE_YAML=dev-config-absolute.yaml
DEV_RUN_ID="dev-test-run"
DEV_BACKEND="json"
DEV_BACKEND_FILE="doit-db-dev.json"
FINAL_DOIT_TASK="copy_source_into_output"
SHOW_CONFIGURATION_TASK="generate_workflow_tasks:Show configuration"

# A helper script to get short descriptions of each target in the Makefile
define PRINT_HELP_PYSCRIPT
import re, sys

for line in sys.stdin:
	match = re.match(r'^([\$$\(\)a-zA-Z_-]+):.*?## (.*)$$', line)
	if match:
		target, help = match.groups()
		print("%-30s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT


help:  ## print short description of each target
	@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)


all:  ## compile all outputs
	# High verbosity for now, may split out `all` and `all-verbose` targets if verbosity is too annoying
	pixi run doit run --verbosity=2

doit-list:  ## list all the doit tasks
	pixi run doit list --all --status

all-ci: $(CI_CONFIG_ABSOLUTE_YAML)  ## compile all outputs using the CI run-id
	DOIT_CONFIGURATION_FILE=$(CI_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID="CI"  DOIT_DB_FILE=".doit_ci" pixi run doit run --verbosity=2

all-dev: $(DEV_CONFIG_ABSOLUTE_YAML)  ## compile all outputs using the dev run-id
	DOIT_CONFIGURATION_FILE=$(DEV_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID=$(DEV_RUN_ID) DOIT_DB_BACKEND=$(DEV_BACKEND) DOIT_DB_FILE=$(DEV_BACKEND_FILE) pixi run doit run --verbosity=2

all-dev-parallel: $(DEV_CONFIG_ABSOLUTE_YAML)  ## compile all outputs using the dev run-id
	DOIT_CONFIGURATION_FILE=$(DEV_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID=$(DEV_RUN_ID) DOIT_DB_BACKEND=$(DEV_BACKEND) DOIT_DB_FILE=$(DEV_BACKEND_FILE) pixi run doit run --verbosity=2 -n 6

all-debug-dev: $(DEV_CONFIG_ABSOLUTE_YAML)  ## compile all outputs using the dev run-id, falling to debugger on failure
	DOIT_CONFIGURATION_FILE=$(DEV_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID=$(DEV_RUN_ID) DOIT_DB_BACKEND=$(DEV_BACKEND) DOIT_DB_FILE=$(DEV_BACKEND_FILE) pixi run doit run --pdb

clean-dev: $(DEV_CONFIG_ABSOLUTE_YAML)  ## clean all the dev outputs (add --dry-run for dry run)
	DOIT_CONFIGURATION_FILE=$(DEV_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID=$(DEV_RUN_ID) DOIT_DB_BACKEND=$(DEV_BACKEND) DOIT_DB_FILE=$(DEV_BACKEND_FILE) pixi run doit clean

doit-list-dev: $(DEV_CONFIG_ABSOLUTE_YAML)  ## list all the doit tasks using the dev run-id
	DOIT_CONFIGURATION_FILE=$(DEV_CONFIG_ABSOLUTE_YAML) DOIT_RUN_ID=$(DEV_RUN_ID) DOIT_DB_BACKEND=$(DEV_BACKEND) DOIT_DB_FILE=$(DEV_BACKEND_FILE) pixi run doit list --all --status

# To add:
# - doit status for status of individual tasks
# - doit info for info (i.e. metadata) of individual tasks
# - doit forget --all for resetting the database

test: $(CI_CONFIG_YAML)  ## run the tests
	pixi run -e tests pytest -r a -v src tests --doctest-modules

$(DEV_CONFIG_ABSOLUTE_YAML) $(CI_CONFIG_YAML) $(CI_CONFIG_ABSOLUTE_YAML): $(DEV_CONFIG_YAML) scripts/create-dev-ci-config-absolute.py
	pixi run python scripts/write-config.py

.PHONY: checks
checks:  ## run all the linting checks of the codebase
	@echo "=== pre-commit ==="; pixi run -e all-dev pre-commit run --all-files || echo "--- pre-commit failed ---" >&2; \
		echo "=== mypy ==="; MYPYPATH=stubs pixi run -e all-dev mypy src notebooks || echo "--- mypy failed ---" >&2; \
		echo "======"

.PHONY: changelog-draft
changelog-draft:  ## compile a draft of the next changelog
	pixi run -e all-dev towncrier build --draft

.PHONY: changelog
changelog:  ## compile the changelog entries into CHANGELOG.md
	pixi run -e all-dev towncrier build

virtual-environment: pyproject.toml  ## update virtual environment, create a new one if it doesn't already exist
	pixi install
	pixi run -e all-dev pre-commit install