morosanmihail / kraken-build

The Kraken build stystem.

 

kraken-build

Kraken is a task orchestration system. It sets itself apart from traditional build systems in that it does not try to replace good build tooling that already exists, but instead build on top of it and orchestrate the invokations of high-level tools like Cargo (Rust) and Poetry (Python).

The primary goal of Kraken is to drastically accelerate the setup of new projects and benefit from the ability to roll out new features in the software development lifecycle at scale.

Kraken is currently primarily used and developed at Helsing.

Getting started

Kraken is best invoked in your project using the Kraken wrapper CLI krakenw. It takes care of installing the same version of Kraken for your project in any environment. The recommended way to install the wrapper is with Pipx. The wrapper is compatible with Python 3.7 and newer, however the Kraken core requires Python 3.10. ⁽¹⁾ The wrapper is clever enough to find an appropriate Python 3.10 installation on your system.

Package	Python Version
kraken-common	3.7+
kraken-core	3.10
kraken-std	3.10
kraken-wrapper	3.7+

To install kraken-wrapper with Pipx:

$ pipx install kraken-wrapper

^{(1) Due to an issue in Dill, Python 3.11 is not currently supported.}

Kraken's build scripts are called .kraken.py and are written in Python. For krakenw to know what to install for your project, you need to begin your script with a call to the buildscript() function. The kraken-std package provides the core buisiness logic.

from kraken.common import buildscript
buildscript(requirements=["kraken-std"])

Subsequently, you can import from the kraken.std module to import the functionality you need to describe your project's build:

from kraken.std import python
python.mypy()
python.flake8()

Development

Kraken uses Slap as the Python build backend. Currently, the repository is not configured to fully be fully managed by Kraken itself (only kraken-std is). If you need a fresh installation of all Kraken components, you can run the Slap CLI:

$ slap venv -ac
$ slap install --link

You need at least Slap 1.9.1.

In CI, we currently use a combination of krakenw and Slap to test the repository. The krakenw CLI is used only for kraken-std at the moment as it is the only one with a build script. However, we always lag behind in the version of Kraken we can use to self-manage the repository (i.e. the latest feature that you added to kraken-std cannot be used in the same version of it to build itself).

Releases

All packages in this repository are released under the same version number simultaneously. Regardless, we still follow to indicate the severity of changes, and packages in this repository are expected to be compatible with one another according to semantic versioning.

A release must be created by a maintainer that has write access to the develop branch. The release process is automated using Slap.

$ slap release -tp <patch|minor|major|x.y.z>
$ slap publish