idf-ci

Python toolkit for CI/CD of ESP-IDF projects.

Installation

pip install -U idf-ci

Basic Usage

Initialize Configuration Files

# Create .idf_ci.toml with default CI settings
idf-ci init-profile

# Create .idf_build_apps.toml with default build settings
idf-ci build init-profile

# Create pytest.ini with default test settings
idf-ci test init-profile

Build Apps

# Build all apps
idf-ci build run

# Build apps for 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 implement a pytest plugin to run tests with sensible defaults with another plugin pytest-embedded

# Only collect tests that would run
pytest --collect-only

# Run tests with target esp32
pytest --target esp32

Documentation

For detailed usage and configuration options, please refer to the documentation.