idf-ci
A tool designed to streamline CI/CD for ESP-IDF projects, with support for both GitLab CI/CD and GitHub Actions.
Installation
pip install -U idf-ci
Key Features
-
Sensible Defaults
Easy setup with default settings for idf-build-apps and pytest-embedded.
-
Build Management
Build ESP-IDF apps for multiple targets (ESP32, ESP32-S2, ESP32-C3, etc.) with parallel builds and smart filtering based on changed files or test needs.
-
Test Management
Run
pytestwith ESP-IDF configs, including target-specific test discovery and marker filtering. -
GitLab CI/CD Integration
Full pipeline support with artifacts, S3 uploads, and auto-generated jobs for builds and tests.
-
GitHub Actions Integration
Generate test matrix from project settings.
Basic Usage
Initialize Configuration Files
# Create .idf_ci.toml with default idf-ci settings
idf-ci init
# Create .idf_build_apps.toml with default build settings
idf-ci build init
# Create pytest.ini with default test settings
idf-ci test init
Build Apps
# Build all apps
idf-ci build run
# Build apps for a specific target
idf-ci build run -t esp32
# Build only test-related apps
idf-ci build run --only-test-related
# Preview what would be built (dry run)
idf-ci build run --dry-run
Run Tests
We provide a pytest plugin that works with pytest-embedded to run tests with sensible defaults.
# Only collect tests that would run
pytest --collect-only
# Run tests for the esp32 target
pytest --target esp32
Documentation
For detailed usage and configuration options, please refer to the documentation.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file idf_ci-1.2.1.tar.gz.
File metadata
- Download URL: idf_ci-1.2.1.tar.gz
- Upload date:
- Size: 77.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b10fd64d3f8a9f10e09ce4c93d01a31909ecbbdb362d8be159bb88c3b777ff2
|
|
| MD5 |
f653b902b30f053aa82c8f5631ede2b6
|
|
| BLAKE2b-256 |
40bb0c5a478561e3167286e960e7f83578df9739d55ae573008b2b51be12daaa
|
Provenance
The following attestation bundles were made for idf_ci-1.2.1.tar.gz:
Publisher:
publish-to-pypi.yml on espressif/idf-ci
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
idf_ci-1.2.1.tar.gz -
Subject digest:
5b10fd64d3f8a9f10e09ce4c93d01a31909ecbbdb362d8be159bb88c3b777ff2 - Sigstore transparency entry: 2216980353
- Sigstore integration time:
-
Permalink:
espressif/idf-ci@858764e49b6a5db14b4243e21e5110efdc12d31f -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/espressif
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@858764e49b6a5db14b4243e21e5110efdc12d31f -
Trigger Event:
push
-
Statement type:
File details
Details for the file idf_ci-1.2.1-py3-none-any.whl.
File metadata
- Download URL: idf_ci-1.2.1-py3-none-any.whl
- Upload date:
- Size: 70.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
01ef3dda61b6bfc7016e5c1de777e6d8321d66632e74ce34d674cad9c9568322
|
|
| MD5 |
4b4f4a895e4e25a08cbe95af414e4a6c
|
|
| BLAKE2b-256 |
7eed6996985b5bcf0e137c6f3abed8fc3793713d602b55fbf17e498a24d48f48
|
Provenance
The following attestation bundles were made for idf_ci-1.2.1-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on espressif/idf-ci
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
idf_ci-1.2.1-py3-none-any.whl -
Subject digest:
01ef3dda61b6bfc7016e5c1de777e6d8321d66632e74ce34d674cad9c9568322 - Sigstore transparency entry: 2216980396
- Sigstore integration time:
-
Permalink:
espressif/idf-ci@858764e49b6a5db14b4243e21e5110efdc12d31f -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/espressif
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@858764e49b6a5db14b4243e21e5110efdc12d31f -
Trigger Event:
push
-
Statement type:
