idf-ci Logo

Explanations

  • Config Files

Guides

  • Build Commands
  • GitLab Commands
  • Test Commands
  • Recommended .gitignore Settings
  • Preview CI Behavior Locally

References

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

Recommended .gitignore Settings

The idf-ci tool provides default configurations for CI/CD processes. During execution, it generates various output files like binaries, logs, and build reports. To keep your repository clean and prevent committing generated files, add these entries to your .gitignore file:

.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.