Tools for setup-free CircuitPython builds

tools/docker-build/Dockerfile

@@ -0,0 +1,41 @@
+FROM ubuntu:24.04 as build
+
+RUN apt-get update && apt-get install -y build-essential software-properties-common git git-lfs gettext cmake mtools wget curl which
+
+ARG ARM_TOOLCHAIN_URL=https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/
+ARG ARM_TOOLCHAIN_FILE=arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-eabi.tar.gz
+ARG DOWNLOAD_DIR=/root/bin
+
+RUN mkdir ${DOWNLOAD_DIR} && cd ${DOWNLOAD_DIR} && curl -LO ${ARM_TOOLCHAIN_URL}/${ARM_TOOLCHAIN_FILE}
+
+RUN cd ${DOWNLOAD_DIR} && pwd && tar -xf ${ARM_TOOLCHAIN_FILE}
+
+ARG ARM_TOOLCHAIN_DIR=arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi
+
+ENV PATH="${PATH}:${DOWNLOAD_DIR}/${ARM_TOOLCHAIN_DIR}/bin"
+
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -y | sh
+
+RUN apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build
+
+RUN apt-get install -y ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 python-is-python3
+
+ENV IDF_TOOLS_PATH=/root/.espressif
+ENV IDF_PATH=/root/esp/esp-idf
+
+RUN mkdir -p /root/esp && cd /root/esp && git clone -b v5.2.2 --recursive https://github.com/espressif/esp-idf.git && ls
+
+RUN cd /root/esp/esp-idf && ./install.sh all
+
+RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-dev.txt
+
+RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-doc.txt
+
+RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r requirements-dev.txt && \
+           pip3 install --upgrade -r requirements-doc.txt
+
+COPY build.sh /root
+
+RUN chmod +x /root/build.sh
+
+ENTRYPOINT ["/bin/bash"]

tools/docker-build/README.md

@@ -0,0 +1,22 @@
+# Building CircuitPython with Docker
+
+On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `sudo tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
+
+```bash
+    cd ~/circuitpython
+    sudo tools/docker-build/build espressif adafruit_feather_esp32s2_reverse_tft
+    sudo tools/docker-build/build raspberrypi waveshare_rp2040_zero
+    sudo tools/docker-build/build atmel-samd grandcentral_m4_express DEBUG=1
+```
+
+will build executables for a Feather ESP32S2 board, a Waveshare RP2040 board and an Adafruit Grand Central M4 Express board, and the Grand Central build will include debugging information.
+
+## Building a new Docker image
+
+The `build` script uses tools built into a container image pulled from a public Docker Hub repository.  If you like, you can build your own image from the `Dockerfile` in this directory with the command
+
+```bash
+    docker build -t <name> .
+```
+
+Where <name> is the name that will be applied to the image.  If you then change the value of `$LOCAL_IMAGE` in the `build` script to match <name>, `build` will use the new image for building CircuitPython.

tools/docker-build/build

@@ -0,0 +1,9 @@
+#!/bin/bash
+REMOTE_IMAGE="timchinowsky/build_circuitpython"
+LOCAL_IMAGE="timchinowsky/build_circuitpython"
+
+make fetch-all-submodules
+docker pull $REMOTE_IMAGE
+docker run -it -v .:/root/circuitpython $LOCAL_IMAGE /root/build.sh $1 $2 $3
+chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` *
+chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` .git

tools/docker-build/build.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+DIR=$(pwd)
+
+git config --global --add safe.directory /root/circuitpython
+git config --global --add safe.directory /root/circuitpython/ports/espressif/esp-idf
+
+cd /root/circuitpython
+
+make fetch-tags
+
+. /root/esp/esp-idf/export.sh
+
+cd /root/circuitpython/ports/$1
+
+# cd $DIR
+
+make BOARD=$2 $3