Release/v2.0 by brianignacio5 · Pull Request #1704 · espressif/vscode-esp-idf-extension

brianignacio5 · 2025-11-03T10:19:59Z

Description

EIM Integration Release

This pull request significantly refactors the CI workflow and documentation to modernize ESP-IDF installation, simplify test execution, and update configuration guidance for additional frameworks. The most impactful changes are the removal of the custom Docker-based GitHub Action in favor of using Espressif’s official setup action, improvements to test reporting, and updates to documentation for clarity and current best practices.

CI/CD Pipeline Modernization:

Removed the custom .github/actions/idf Docker-based GitHub Action, including its Dockerfile, action.yml, and shell scripts, in favor of using the official espressif/install-esp-idf-action for setting up ESP-IDF in CI workflows. This simplifies maintenance and aligns with upstream best practices. [1] [2] [3] [4]
Updated .github/workflows/ci.yml and .github/workflows/ui-test.yml to use the official ESP-IDF setup action, improved Node.js and Yarn setup, and replaced custom test output handling with standardized test reporting using dorny/test-reporter. Also added robust JSON extraction and artifact upload for UI test results. [1] [2] [3]

Documentation Updates:

Revised the setup instructions in README.md to recommend using the ESP-IDF Install Manager and updated the workflow for selecting and configuring ESP-IDF versions in VS Code. This reflects the latest recommended installation and configuration processes. [1] [2]
Updated the documentation for integrating additional frameworks (ADF, MDF, Matter, Rainmaker, HomeKit) to use environment variables set via idf.customExtraVars instead of deprecated configuration keys, both in English and Chinese documentation. [1] [2] [3] [4] [5] [6]
Removed obsolete or redundant documentation, such as the "Clear Saved ESP-IDF Setups" table entry.

These changes collectively improve maintainability, reduce custom code, and ensure that both CI and user documentation are up-to-date with current Espressif tooling and extension capabilities.

Fix #1696
Fix #1759

Type of change

Breaking change (fix or feature that would cause existing functionality to not work as expected)

Steps to test this pull request

This PR requires an overall test of the extension to make sure all features work. This PR include breaking changes in the way the ESP-IDF is installed now using the ESP-IDF Installation Manager (EIM)

Expected behaviour:

Install using the EIM.

Expected output:

How has this been tested?

Manual testing of overall extension features.

Test Configuration:

ESP-IDF Version: 5.5.1
OS (Windows,Linux and macOS): All

Checklist

github-actions · 2025-11-03T11:55:25Z

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

esp-idf-extension.vsix.zip
Espressif documentation preview

eMUQI · 2025-11-22T02:15:13Z

Hi, I noticed this PR has been open for about three weeks. May I ask when we can expect the official release of V2.0? Thank you for your work!

github-actions · 2025-12-21T00:32:36Z

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

github-actions · 2026-01-10T00:30:15Z

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

* draft eim integration * update init extension auto config * rm global state idf setups * do not show invalid extension when showOnboardingOnInit is false * rm duplicate code * update welcome show * fix new projext examples esp idf loading * update default esp_ide json file * add eim verify idf setup functions * update to eim_idf json file name * save settings as env variables * rm settings use customExtraVars instead * fix save docker settings * check empty customExtraVars PATH * fix getConfigurationSettings * rm old setup * fix lint * rm setup webpack update python in project test * use customextravars first * add selected workspace global config * use process env if customextra vars not available * default tools path * test doctor command * write customExtraVars from process env if available * fix workspace arg * update menuconfig test rm doc cmd * add PYTHON env var * log doctor command output clean project first * add missing timeout * test debug vscode * add PYTHON env var * add env PYTHON save settings * fallback on global state setups * escape activation script path if spaces * move IDF_PATH to workspace state, move frameworks settings to customExtraVars * update rm global setups * use env vars if idfSetups not defined, rm redudant code downloadManager and tests * read esp idf setups from esp_idf.json * await getConfigurationAccess * add logger init * fix IDF_TOOLS_PATH not defined if default * add PYTHON to env variables * change checkIdfSetup to isIdfSetupValid rm IEspIdfTool fields * remove env systemDriver use C in Windows default eim_idf json path * log activation script output * change to error logs * update activationScript split regex * fix IDF_PYTHON_ENV_PATH to envDict * loadIdfSetup save idf.gitPath * add path to prepareEnv * fix idf size ui * add idf setups in doctor command * add validation for eim load env setup * idfSetupToUse add validation * fix load idf.currentSetup * rm idf.espIdfPath from docs rm duplicate idfSetups use old idf.espIdfPath if no idf.currentSetup * add download extract install run eim from extension * fx linux exe call * use env shell for activation script * allow pick mirror eim download, add l10n for msg * fix errors * fix env vars in clang validate * use latest vscode-extension-tester * use eimPath field in eim_idf json to open existing executable if exists * rm idf setup validation, only in doctor cmd * fix checkPyVenv object * rm idf.toolsPath reference * use idf toolsPath old setting to find esp_idf json file * rm use of ESP_IDF_VERSION in status bar * add missing v for idf version * update walkthrough install step * add idf.eimExecutableArgs for eim gui or cli * use & intead of launch process * make sure that eim_unified_release is not cached, rm quote * close notifications befor doctor cmd * mv dismiss to before * fix lint * fix ts issues * use default tools path instead of temp for eim download * add default EIM locations to match Espressif IDE and use EIM_PATH * test json reporter no use of docker * add expected test env vars * add results in console too, rm actions idf fix doctor test * replace user path in doctor test * test using e2e ui reports * test extester mocha options * update options as object * update reporter option * try to parse json from console * fix console output parsing * update console output parse error handle * clean json step * update test log to test locally * rm text after closing json * update end regex * update parsing with test data * fail on test error * update bulma packages and use new syntax

…tions

Fabricio-ESP

Confirmed working. Tested with EIM release 0.7.1
No issues found on regular customer use cases.

Fabricio-ESP

Docs update

Fabricio-ESP · 2026-02-03T07:00:52Z

docs_espressif/en/installation.rst

    - Navigate to ``View`` > ``Command Palette``.

-    - Type ``ESP-IDF: Configure ESP-IDF Extension`` and select the command to launch the setup wizard. A loading notification will appear, followed by the setup wizard.
+    - Type ``ESP-IDF: Open ESP-IDF Install Manager`` to download and run the ESP-IDF install manager to install the ESP-IDF framework. A loading notification will appear, followed by the execution of the installer.


"ESP-IDF Installation Manager"
To follow the same name indicated on the EIM webpage.

I noticed that the command itself has a different name from the command palette or the explorer panel.

Fabricio-ESP · 2026-02-03T07:01:25Z

docs_espressif/en/installation.rst

-    .. image:: ../../media/tutorials/setup/select-mode.png
-
-2.  Choose ``Express`` and select the download server:
+2.  Alternatively, you can download the ESP-IDF Install Manager from the following link `ESP-IDF Install Manager <https://dl.espressif.com/dl/eim/index.html>`_ among the following options:


"ESP-IDF Installation Manager"

Fabricio-ESP · 2026-02-03T07:02:14Z

docs_espressif/en/installation.rst

-    - ESP-IDF download progress
-    - ESP-IDF Tools download and installation progress
-    - Creation of a Python virtual environment and installation of ESP-IDF Python requirements
+3.  Use the ESP-IDF Install Manager to install the ESP-IDF and tools. If necessary, here is the `ESP-IDF Install Manager Documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/general_info.html>`_.


same "Installation"

Fabricio-ESP · 2026-02-03T07:55:53Z

README.md

-</p>
-
-7. Choose **Express** and select the download server:
+7. Alternatively, you can download the ESP-IDF Install Manager from the following link [ESP-IDF Install Manager](https://dl.espressif.com/dl/eim/index.html) among the following options::


"Installation Manager" here as well.

Fabricio-ESP · 2026-02-03T07:56:43Z

README.md

-10. If your operating system is MacOS/Linux, choose the system Python executable to create ESP-IDF virtual environment inside ESP-IDF Tools and install ESP-IDF Python package there.
-
-    > **NOTE:** Windows users don't need to select a Python executable since it is going to be installed by this setup.
+8. Use the ESP-IDF Install Manager to install the ESP-IDF and tools. If necessary, here is the [ESP-IDF Install Manager Documentation](https://docs.espressif.com/projects/idf-im-ui/en/latest/general_info.html).


"Installation Manager"

radurentea

LGTM, nice work!

…idf setup within progress status

radurentea · 2026-02-03T15:35:04Z

I've installed the .vsix and came back with some more feedback regarding the walkthroughs. The updates are not really needed but they could be a nice cleanup for 2.0 release.

ESP-IDF Basic Usage Guide

Step 2:
- I think the recommendation for Linux and MacOs users can be updated with EIM Prerequisites (if needed)
- The text for the command should be modified to ESP-IDF: Open ESP-IDF Installation Manager
- Same with ESP-IDF: Select current ESP-IDF version, should be ESP-IDF: Select Current ESP-IDF Version (capitalized)
- Same here
Step 3:
- This text should be updated: "After clicking the button, you'll be prompted to choose a location where the project will be created.", because the next step is showing the webview with multiple inputs now. (maybe add a screenshot with the page as well?)
Step 4:
- All the text inside the buttons should be updated to have the same text as the associated commands (e.g having the "ESP-IDF:" prefix and be capitalised)
- All commands on the right panel should use the same style format as in step 5.
- Text needs to be updated to SDK Configuration Editor (menuconfig)
- It seems the item for "set target" has changed
  compared with the one in the walkthrough
- Maybe for serial port we can also change the image to because the first time the user will see "detect" as the default value
- Flash Method's icon also changed to from
Step 5:
- Flash Device's icon also changed to from
- Monitor Device's icon also changed to from
- Build, Flash and Monitor's icon also change to from
- Commands on left panel should have ESP-IDF: prefix
- Most of the commands' capitalization on right panel needs to be updated.
Step 6:
- Right panel: ESP-IDF Basic Usage Walkthrough should be change to ESP-IDF Basic Usage Guide Walkthrough

ESP-IDF Advanced Features Guide

Step 1:
- Update to `Completed the Basic Usage Guide Walkthrough" to be more clear, from
Step 2:
- The text of the button should be updated to ESP-IDF: Doctor Command
Step 5:
- Same for , it should be ESP-IDF: Show ESP Component Registry
Step 6:
- Same for the Open Size Analysis command here, it should be ESP-IDF: Size Analysis of the Binaries
Step 7:
- Same for the Open Partition Editor, it should be ESP-IDF: Open Partition Table Editor UI
Step 8:
- The button doesn't work, it's not opening the testing view.
Step 10 (last):
- The list should be updated/capitalized to be similar with the one in our documentation

radurentea · 2026-02-03T16:24:21Z

Here are some changes required for the documentation:

1) docs_espressif\en\additionalfeatures\app-tracing.rst - New Project reference needs to be updated

2) docs_espressif\en\additionalfeatures\coverage.rst - same here

3) docs_espressif\en\additionalfeatures\flash-encryption.rst - Same here (documentation is mentioning ESP-IDF: Show Example Projects

4) docs_espressif\en\additionalfeatures\heap-tracing.rst - same here

5) Skipping tag 2.0.0 - I've also noticed that in the changelog we use 2.0.2, skipping 2.0.0, I forgot if this was intentional or not.

brianignacio5 added this to the v2.0.0 milestone Nov 3, 2025

brianignacio5 requested a review from Fabricio-ESP November 3, 2025 10:19

brianignacio5 self-assigned this Nov 3, 2025

brianignacio5 requested a review from radurentea November 4, 2025 09:00

This was referenced Nov 10, 2025

"troubleshooting documentation" link in VS Code walkthrough landing on "404 Page not found" (VSC-1794) #1705

Closed

ESP-IDF Installation Manager (EIM) black screen (VSC-1747) #1630

Closed

github-actions bot added the stale Stale PR or Issue label Dec 21, 2025

brianignacio5 force-pushed the release/v2.0 branch from 8b401ec to 4633597 Compare December 24, 2025 09:59

brianignacio5 removed the stale Stale PR or Issue label Dec 25, 2025

github-actions bot added the stale Stale PR or Issue label Jan 10, 2026

brianignacio5 removed the stale Stale PR or Issue label Jan 12, 2026

brianignacio5 force-pushed the release/v2.0 branch from 6e30aee to 36d2b19 Compare January 23, 2026 10:04

brianignacio5 added 12 commits January 29, 2026 16:03

fix eim call (#1699)

940bae2

fix eraseFlash task issues

ffbcc88

fix yarn compile

1c28d75

test using 5.4.2

73bdd9e

test use espressif install-esp-idf-action in ci

231f617

rm use of export sh in ci

0ca8df9

Update eim call after download

6954616

try to use eim from PATH if available

d9ca38c

fix lint issues

1407262

fix size cmd

6f4ae2a

fix workspace erase flash task

7834a5b

brianignacio5 force-pushed the release/v2.0 branch from 36d2b19 to 7834a5b Compare January 29, 2026 08:03

desc order idf setups add changelog release notes

d29d636

brianignacio5 added 4 commits January 29, 2026 18:15

update release notes

ed8bffa

fix reference to old settings in hint viewer langTool and serial func…

43cf2c5

…tions

fix docs

86ea7a3

fix openocd paths for devkits

db96272

Fabricio-ESP approved these changes Feb 3, 2026

View reviewed changes

Fabricio-ESP reviewed Feb 3, 2026

View reviewed changes

radurentea approved these changes Feb 3, 2026

View reviewed changes

brianignacio5 added 2 commits February 3, 2026 19:21

update docs and screenshots add wsl eim run install new project load …

5844968

…idf setup within progress status

rm ref to old examples cmd for new project wizard

63b48d6

brianignacio5 added 6 commits February 4, 2026 13:09

changes in walkthrough and docs

d6b1c03

fix docs zh cn

0202eba

fix doc

ebc8990

fix zh doc

00a12d9

update wsl download run eim

fc14824

fix terminal focus eim

633292e

brianignacio5 merged commit c4c38b6 into master Feb 4, 2026
7 checks passed

Conversation

brianignacio5 commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Steps to test this pull request

How has this been tested?

Checklist

Uh oh!

github-actions bot commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eMUQI commented Nov 22, 2025

Uh oh!

github-actions bot commented Dec 21, 2025

Uh oh!

github-actions bot commented Jan 10, 2026

Uh oh!

Fabricio-ESP left a comment

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP left a comment

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Fabricio-ESP Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

radurentea left a comment

Choose a reason for hiding this comment

Uh oh!

radurentea commented Feb 3, 2026

Uh oh!

radurentea commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

brianignacio5 commented Nov 3, 2025 •

edited

Loading

github-actions bot commented Nov 3, 2025 •

edited

Loading

radurentea commented Feb 3, 2026 •

edited

Loading