Building a release

Tip

Pre-built archives of manufacturing files are available from the releases page on GitHub.

The build sub-command builds a CAM release and places manufacturing files into a _build/ directory which includes:

• a changelog

• a STEP file of the final assembly

• a PNG image of the final assembly

• STL files for 3D printing

Note

These instructions are for building a release on Ubuntu 20.04. Adaptations will be required for other operating systems.

Prerequisites

• Git version control system.

• Python >=3.11, and python-venv.

• Poetry for Python dependency management.

• Mayo 3D CAD viewer and converter for exporting PNG images.

• Optional:

  • ImageMagick for manipulating images.

  • exiftool for manipulating EXIF headers.

  • git-lfs for building documentation.

  • optipng for optimising PNG images.

Ubuntu 20.04

Install prerequisites

sudo apt-get install git python3.11 python3.11-venv imagemagick optipng exiftool

Poetry, Mayo, and git-lfs should be installed according to their respective documentation, and be available in your path.

Clone project and install dependencies

git clone https://github.com/sethfischer/rover.git
cd rover
poetry env use python3.11
poetry install
poetry shell

Build release archive

console build

Additional steps for developers

Enable Git hooks:

make install-git-hooks

Install CQ-Editor:

poetry install --with cq-editor

Build documentation:

git lfs pull
cp .env.dist .env.local  # then edit
set -a && source .env.local && set +a
make -C docs/ clean html

Run linters and tests:

make lint test