name: Build and push Docker image

on:

push:

branches:

- 'master'

- 'release/*'

tags:

- 'v*.*'

env:

# Build the image for amd64 and arm64

BUILD_PLATFORMS: linux/amd64,linux/arm64

DOCKERHUB_REPO: ${{ github.repository_owner }}/esp32-arduino-lib-builder

jobs:

docker:

# Disable the job in forks

if: ${{ github.repository_owner == 'espressif' }}

runs-on: ubuntu-latest

steps:

# Depending on the branch/tag, set CLONE_BRANCH_OR_TAG variable (used in the Dockerfile

# as a build arg) and TAG_NAME (used when tagging the image).

#

# The following 3 steps cover the alternatives (tag, release branch, master branch):

- name: Set variables (tags)

if: ${{ github.ref_type == 'tag' }}

run: |

- name: Set variables (release branches)

if: ${{ github.ref_type == 'branch' && startsWith(github.ref_name, 'release/') }}

run: |

- name: Set variables (main branch)

if: ${{ github.ref_type == 'branch' && github.ref_name == 'master' }}

run: |

# Display the variables set above, just in case.

- name: Check variables

run: |

# The following steps are the standard boilerplate from

# https://github.com/marketplace/actions/build-and-push-docker-images

- name: Checkout

uses: actions/checkout@v4

- name: Login to Docker Hub

uses: docker/login-action@v3

with:

username: ${{ secrets.DOCKERHUB_USERNAME }}

password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Set up QEMU for multiarch builds

uses: docker/setup-qemu-action@v3

- name: Set up Docker Buildx

uses: docker/setup-buildx-action@v3

- name: Build and push

uses: docker/build-push-action@v5

with:

context: tools/docker

push: true

tags: ${{ env.DOCKERHUB_REPO }}:${{ env.TAG_NAME }}

platforms: ${{ env.BUILD_PLATFORMS }}

build-args: |

- name: Update Docker Hub repository description (master branch)

if: ${{ github.ref_type == 'branch' && github.ref_name == 'master' }}

uses: peter-evans/dockerhub-description@v4

with:

username: ${{ secrets.DOCKERHUB_USERNAME }}

password: ${{ secrets.DOCKERHUB_TOKEN }}

repository: ${{ env.DOCKERHUB_REPO }}

readme-filepath: ./tools/docker/README.md

setting_output_permissions = ""

self.title = "Configurator"

parser.add_argument("--output-permissions",

metavar="<uid:gid>",

type=str,

default="",

required=False,

help=argparse.SUPPRESS) # Hidden option. It is only supposed to be used by the docker container

elif args.arduino_path == "/arduino-esp32": # Docker mount point

print("Warning: Docker mount point not found. Disabling copy to Arduino.")

app.setting_enable_copy = False

print("Error: Invalid path to Arduino core: " + os.path.abspath(args.arduino_path))

app.setting_output_permissions = args.output_permissions

import re

def print_warning(self, message: str) -> None:

# Print warning message to the RichLog widget

self.log_widget.write("[b bright_yellow]" + message)

#print("Warning: " + message) # For debugging

if not self.app.setting_target:

self.print_error("No target selected")

label.update("No target selected")

return

elif self.app.setting_target == ",".join(self.app.supported_targets):

if self.app.setting_output_permissions:

regex = r"^[1-9][0-9]*:[1-9][0-9]*$" # Regex to match the uid:gid format. Note that 0:0 (root) is not allowed

if re.match(regex, self.app.setting_output_permissions):

print_info("Setting permissions to: " + self.app.setting_output_permissions)

chown_process = None

try:

chown_process = subprocess.run(["chown", "-R", self.app.setting_output_permissions, self.app.setting_arduino_path])

chown_process.wait()

except Exception as e:

print("Error changing permissions: " + str(e))

if chown_process and chown_process.returncode != 0:

self.print_error("Error changing permissions")

self.print_error("Please change the ownership of generated files manually")

else:

self.print_success("Permissions changed successfully")

elif self.app.setting_output_permissions == "0:0":

self.print_warning("Permissions settings are set to root (0:0)")

self.print_warning("Please change the ownership of generated files manually")

self.print_warning("If you are compiling for Windows, you may ignore this warning")

else:

self.print_error("Invalid permissions format: " + self.app.setting_output_permissions)

self.print_error("Please change the ownership of generated files manually")

def on_mount(self) -> None:

# Event handler called when the screen is mounted

print("Compile screen mounted")

self.sub_title = "Compilation"

FROM ubuntu:22.04

USER root

SHELL ["/bin/bash", "-c"]

ARG DEBIAN_FRONTEND=noninteractive

RUN : \

&& apt-get update \

&& apt-get install -y --no-install-recommends \

bison \

ccache \

cmake \

curl \

flex \

git \

gperf \

jq \

libncurses-dev \

libssl-dev \

libusb-1.0 \

ninja-build \

patch \

python3 \

python3-click \

python3-cryptography \

python3-future \

python3-pip \

python3-pyelftools \

python3-pyparsing \

python3-serial \

python3-setuptools \

python3-venv \

wget \

&& pip3 install --upgrade pip textual-dev \

&& apt-get autoremove -y \

&& rm -rf /var/lib/apt/lists/* \

&& :

ARG LIBBUILDER_CLONE_URL=https://github.com/espressif/esp32-arduino-lib-builder

ARG LIBBUILDER_CLONE_BRANCH_OR_TAG=master

ARG LIBBUILDER_CHECKOUT_REF=

ARG LIBBUILDER_CLONE_SHALLOW=

ARG LIBBUILDER_CLONE_SHALLOW_DEPTH=1

ENV LIBBUILDER_PATH=/opt/esp/lib-builder

ENV IDF_CCACHE_ENABLE=1

RUN echo LIBBUILDER_CHECKOUT_REF=$LIBBUILDER_CHECKOUT_REF LIBBUILDER_CLONE_BRANCH_OR_TAG=$LIBBUILDER_CLONE_BRANCH_OR_TAG && \

git clone --recursive \

${LIBBUILDER_CLONE_SHALLOW:+--depth=${LIBBUILDER_CLONE_SHALLOW_DEPTH} --shallow-submodules} \

${LIBBUILDER_CLONE_BRANCH_OR_TAG:+-b $LIBBUILDER_CLONE_BRANCH_OR_TAG} \

$LIBBUILDER_CLONE_URL $LIBBUILDER_PATH && \

git config --system --add safe.directory $LIBBUILDER_PATH && \

if [ -n "$LIBBUILDER_CHECKOUT_REF" ]; then \

cd $LIBBUILDER_PATH && \

if [ -n "$LIBBUILDER_CLONE_SHALLOW" ]; then \

git fetch origin --depth=${LIBBUILDER_CLONE_SHALLOW_DEPTH} --recurse-submodules ${LIBBUILDER_CHECKOUT_REF}; \

fi && \

git checkout $LIBBUILDER_CHECKOUT_REF && \

git submodule update --init --recursive; \

fi

COPY entrypoint.sh $LIBBUILDER_PATH/entrypoint.sh

WORKDIR /opt/esp/lib-builder

ENTRYPOINT [ "/opt/esp/lib-builder/entrypoint.sh" ]

CMD [ "python3", "tools/config_editor/app.py" ]

This is a Docker image for the [ESP32 Arduino Lib Builder](https://github.com/espressif/esp32-arduino-lib-builder). It is intended for building the static libraries of ESP-IDF components for use in Arduino projects.

This image contains a copy of the esp32-arduino-lib-builder repository and already include or will obtain all the required tools and dependencies to build the Arduino static libraries.

Currently supported architectures are:

- `amd64`

- `arm64`

Multiple tags of this image are maintained:

- `latest`: tracks `master` branch of esp32-arduino-lib-builder

- `release-vX.Y`: tracks `release/vX.Y` branch of esp32-arduino-lib-builder

docker run --rm -it -e "TERM=xterm-256color" -v <path to arduino-esp32>:/arduino-esp32 espressif/esp32-arduino-lib-builder:latest

The above command explained:

- `docker run`: Runs a command in a new container.

- `--rm`: Optional. Automatically removes the container when it exits. Remove this flag if you plan to use the container multiple times.

- `-i`: Runs the container in interactive mode.

- `-t`: Allocates a pseudo-TTY.

- `-e "TERM=xterm-256color"`: Optional. Sets the terminal type to `xterm-256color` to display colors correctly.

- `-v <path to arduino-esp32>:/arduino-esp32`: Optional. Mounts the Arduino Core for ESP32 repository at `/arduino-esp32` inside the container. Replace `<path to arduino-esp32>` with the path to the repository on the host machine. If not provided, the container will not copy the compiled libraries to the host machine.

- `espressif/esp32-arduino-lib-builder:latest`: The Docker image to use.

After running the above command, you will be inside the container and can build the libraries using the user interface.

By default the docker container will run the user interface script. If you want to run a specific command, you can pass it as an argument to the docker run command. For example, to run a terminal inside the container, you can run:

docker run -it espressif/esp32-arduino-lib-builder:latest /bin/bash

For more information about this image and the detailed usage instructions, please refer to the Arduino Core for ESP32 documentation.

set -e

if [ -n "${LIBBUILDER_GIT_SAFE_DIR+x}" ]

echo "Adding following directories into git's safe.directory"

echo "$LIBBUILDER_GIT_SAFE_DIR" | tr ':' '\n' | while read -r dir

do

git config --global --add safe.directory "$dir"

echo " $dir"

done

if [ -d "/arduino-esp32" ] && [[ "$@" == "python3 tools/config_editor/app.py"* ]]; then

# Running UI with mount point detected, adding -c and --output-permissions arguments

echo "Output folder permissions: `stat -c "%u:%g" /arduino-esp32`"

exec "$@" -c /arduino-esp32 --output-permissions `stat -c "%u:%g" /arduino-esp32`

# Running UI without mount point detected or running another command

exec "$@"