Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add save-defconfig cmd #1094

Merged
merged 3 commits into from
Jan 25, 2024
Merged

add save-defconfig cmd #1094

merged 3 commits into from
Jan 25, 2024

Conversation

brianignacio5
Copy link
Collaborator

Description

Add ESP-IDF: Save Default SDKCONFIG file (save-defconfig) command to create a sdkconfig.defaults file from current project using idf.py save-defconfig command in the back.

PTAL @boris-gu

Fixes #1090

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Click on "ESP-IDF: Save Default SDKCONFIG file (save-defconfig)"
  2. Execute action.
  3. Observe results. The IDF Save Default SDKCONFIG task should show the idf.py save-defconfig output. The sdkconfig.defaults should be generated.

How has this been tested?

Manual testing of running command with blink example from ESP-IDF v5.0.4

Test Configuration:

  • ESP-IDF Version: 5.0
  • OS (Windows,Linux and macOS): MacOS

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

@brianignacio5 brianignacio5 added the enhancement New feature or request label Dec 13, 2023
@brianignacio5 brianignacio5 added this to the v1.7.0 milestone Dec 13, 2023
@brianignacio5 brianignacio5 self-assigned this Dec 13, 2023
Copy link

github-actions bot commented Dec 13, 2023

Download the artifacts for this pull request:

Copy link
Collaborator

@radurentea radurentea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Naming consistency question: I remember I used SDKConfig in the past, checking esp-idf documentation I see there is no naming consistency, should we stick with SDKCONFIG?
  2. The output from idf.py is not very straight forward as can be seen in this screenshot
    Screenshot 2023-12-14 110140
  • I think we should add a message to the output channel and focus it, in case notifications are off
  • we can maybe also open/focus (if it's already opened) the sdkconfig.defaults file after the task is finished?

Copy link

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 github-actions bot added the stale Stale PR or Issue label Dec 30, 2023
@github-actions github-actions bot closed this Jan 4, 2024
@radurentea radurentea added ongoing Ongoing Issue or PR, this label will be used for issue or PR which is to be excluded by stale bot and removed stale Stale PR or Issue labels Jan 4, 2024
@radurentea radurentea reopened this Jan 4, 2024
@brianignacio5 brianignacio5 force-pushed the feature/save-defconfig branch from 30e5069 to f68fe2f Compare January 19, 2024 09:34
@brianignacio5 brianignacio5 force-pushed the feature/save-defconfig branch from f68fe2f to b350dc8 Compare January 23, 2024 05:03
@AndriiFilippov
Copy link
Collaborator

AndriiFilippov commented Jan 25, 2024

@brianignacio5 hi !

Tested under:
OS - Windows 10
ESP-IDF: v5.1.2

  1. Run "ESP-IDF: Save Default SDKCONFIG file (save-defconfig)" -> sdkconfig.default created 👍
  2. Update sdkconfig with custom configs -> Run "ESP-IDF: Save Default SDKCONFIG file (save-defconfig)" -> delete sdkconfig -> build project -> do see new sdkconfig generated with settings from sdkconfig.default 👍

LGTM 👍

@brianignacio5 brianignacio5 merged commit 970d065 into master Jan 25, 2024
6 checks passed
@brianignacio5 brianignacio5 deleted the feature/save-defconfig branch January 25, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ongoing Ongoing Issue or PR, this label will be used for issue or PR which is to be excluded by stale bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Add the "save configuration as default" button (VSC-1254)
3 participants