idf-ci Logo

Explanations

  • Config Files

Guides

  • CLI Overview
  • Recommended .gitignore Settings
  • idf-ci Configuration
  • Preview CI Behavior Locally
  • Migration Guide to idf-ci 1.x

References

  • Build Config File
  • CI Config File
  • CLI Commands
  • GitLab Environment Variables
  • Test Config File
  • API Reference
idf-ci
  • Recommended .gitignore Settings
  • View page source

Recommended .gitignore Settings

The idf-ci tool generates output such as binaries, logs, and reports. To keep your repository clean and avoid committing generated files, add these entries to your .gitignore file. Adjust as needed if you want to keep specific artifacts under version control.

.pytest_cache/
__pycache__/

# esp-idf built binaries
build/
build_*_*/
sdkconfig

# idf-ci build run output
build_summary_*.xml
app_info_*.txt
size_info_*.txt

# pytest-embedded log folder
pytest_embedded_log/

# idf-component-manager output
dependencies.lock
Previous Next

© Copyright 2025, Espressif Systems (Shanghai) Co., Ltd..

Built with Sphinx using a theme provided by Read the Docs.