This is an old revision of the document!
Table of Contents
ESP-IDF Versions & Releases
The full history of releases can be found on the GitHub repository Releases page. There you can find release notes, links to each version of the documentation, and instructions for obtaining each version.
Documentation
The documentation for the current stable release version can always be found at this URL: https://docs.espressif.com/projects/esp-idf/en/stable/ Documentation for the latest version (master branch) can always be found at this URL: https://docs.espressif.com/projects/esp-idf/en/latest/
Versioning Scheme
ESP-IDF uses Semantic Versioning. This means that:
- Major Releases, like v3.0
- Minor Releases like v3.1
- Bugfix Releases like v3.0.1
If updating to a new bugfix release (for example, from v3.0 to v3.0.1), you do not need to change any code in your project, and you only need to re-test the functionality directly related to bugs listed in the release notes on the Releases page.
Checking the Current Version
The local ESP-IDF version can be checked by using git:
cd $IDF_PATH git describe --tags --dirty
The ESP-IDF version is also compiled into the firmware and can be accessed (as a string) via the macro IDF_VER. The default ESP-IDF bootloader will print the version on boot (the version information is not always updated in code, it only changes if that particular source file is recompiled). Examples of ESP-IDF versions:
| Version String | Meaning |
|---|---|
| v3.2-dev-306-gbeb3611ca | Master branch pre-release. v3.2-dev - in development for version 3.2. 306 - number of commits after v3.2 development started. beb3611ca - commit identifier. |
| v3.0.2 | Stable release, tagged v3.0.2. |
| v3.1-beta1-75-g346d6b0ea | Beta version in development (on a release branch). v3.1-beta1 - pre-release tag. 75 - number of commits after the pre-release beta tag was assigned.346d6b0ea - commit identifier. |
| v3.0.1-dirty | Stable release, tagged v3.0.1. dirty means that there are modifications in the local ESP-IDF directory. |