makefile

# This is a default makefile for the Zephyr project, that is supposed to be 
# initialized with West and built with East. 
#
# This makefile in combination with the Github actions does the following:
# * Installs python dependencies and toolchain
# * Initializes the project with West and updates it
# * Runs east release
# If the _build_ is running due to the release creation, then the following also 
# happens:
# * Creates 'artefacts' folder,
# * Copies release zip files and extra release notes files into it.
#
# Downloaded West modules, toolchain and nrfutil-toolchain-manager are cached in 
# CI after the first time the entire build is run.
#
# The assumed precondition is that the repo was setup with below commands:
# mkdir -p <project_name>/project
# cd <project_name>/project
# git clone <project_url> .
#
# Every target assumes that is run from the repo's root directory, which is 
# <project_name>/project.

install-dep:
	east install nrfutil-toolchain-manager
	# Below line is needed, as the toolchain manager might be cached in CI, but not configured
	~/.local/share/east/tooling/nrfutil/nrfutil-toolchain-manager.exe config --install-dir ~/.local/share/east

project-setup:
	# Make a West workspace around this project
	east init -l .
	# Clone submodules
	git submodule update --init --recursive
	# Use a faster update method
	east update -o=--depth=1 -n
	east install toolchain

pre-build:
	echo "Pre-build"

# Runs on every push to the main branch
quick-build:
	east build -b nrf52840dk_nrf52840 samples/version_test -d build_i2c -- -DDTC_OVERLAY_FILE=notecard_over_i2c.overlay

# Runs on every PR and when doing releases
release:
	# Do not do anything, this is a driver project with some custom build steps which are not yet supported by the East

# Pre-package target is only run in release process.
pre-package:
	mkdir -p artefacts
	cp scripts/pre_changelog.md artefacts
	cp scripts/post_changelog.md artefacts

# CodeChecker section
# build and check targets are run on every push to the `main` and in PRs.
# store target is run only on the push to `main`.
# diff target is run only in PRs.
#
# Important: If building more projects, make sure to create separate build
# directories with -d flag, so they can be analyzed separately, see examples
# below.
codechecker-build: quick-build

codechecker-check:
	east codechecker check -d build_i2c

codechecker-store:
	east codechecker store -d build_i2c

# Specify build folders that you want to analyze to the script as positional 
# arguments, open it to learn more.
codechecker-diff:
	scripts/codechecker-diff.sh build_i2c