Skip to content
check

GitHub Action

ESP-IDF v4.x build

v4.2 Latest version

ESP-IDF v4.x build

check

ESP-IDF v4.x build

GitHub Action to build your ESP32 code using the official Docker container from Espressif

Installation

Copy and paste the following snippet into your .yml file.

              

- name: ESP-IDF v4.x build

uses: CalinRadoni/esp-idf-v4-container-action@v4.2

Learn more about this action in CalinRadoni/esp-idf-v4-container-action

Choose a version

ESP-IDF v4.x build

GitHub Action to build your ESP32 code using the official Docker container from Espressif.

From espressif/idf tags I have implemented:

  • latest
  • v4.2 and release-v4.2
  • v4.1 and release-v4.1

Outputs

result

The exit code of idf.py build command.

Example usage

Use the tag to select the desired version of the espressif/idf Docker container. For espressif/idf:v4.1 use:

uses: CalinRadoni/esp-idf-v4-container-action@v4.1

To display the exit code use:

- name: Build the code
  uses: CalinRadoni/esp-idf-v4-container-action@v4.1
  id: esp-idf-build

- name: Show the exit code
  run: echo "The exit code was ${{ steps.esp-idf-build.outputs.result }}"

For more complex usage including:

  • the overriding of the entrypoint script
  • ESP-IDF components in external repositories
  • adding a badge in the README.md page

see the ESP32BoardManager repository.