README.md

ESP-IDF Docker Image with Sonar Cloud

Docker image for the Espressif IoT Development Framework (ESP-IDF), with Sonar Cloud C/C++ code analysis support. It is intended for building applications and libraries with specific versions of ESP-IDF, when doing automated builds.

This image contains a copy of ESP-IDF and all the tools necessary to build and analyze ESP-IDF projects.

Characteristics

• Inherits from the official ESP-IDF Docker image.
• Has the same usage as the official image.
• Adds only two Sonar softwares:
  • Sonar Cloud Scanner CLI
  • Sonar Cloud C/C++ Build Wrapper

Tags

ESP-IDF release:

• v5.3
• v4.4.8

Basic Usage

Build a project located in the current directory using idf.py build command.
Code will be analyzed, and results will be sent to Sonar Cloud, automatically.
Omitting the environment variables will disable code analysis.

docker run --rm \
           --env SONARCLOUD_ORGANIZATION=yourSonarCloudOrganizationName \
           --env SONARCLOUD_TOKEN=yourSonarCloudOrganizationToken \
           -v $PWD:/project \
           -w /project \
           gfurtadoalmeida/esp32-docker-sonar:v5.1 \
           idf.py build

Documentation

For more information about this image and the detailed usage instructions, please refer to the ESP-IDF Programming Guide page: IDF Docker Image.

⚠️ Your project must have a sonar-project.properties file when running code analysis.

Environment Variables

• SONARCLOUD_ORGANIZATION: a Sonar Cloud organization name.
• SONARCLOUD_TOKEN: a Sonar Cloud organization token. If empty code analysis will not be run.
• BUILD_WRAPPER_OUTPUT_DIR: output path for the Sonar Cloud Build Wrapper (defaults to build_wrapper_output if not passed).

Contributing

To contribute to this project make sure to read our CONTRIBUTING.md file.