Thanks to visit codestin.com
Credit goes to github.com

Skip to content

esp32/boards: Remove remaining "id" entries from board.json. #16584

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

Merged

Conversation

dpgeorge
Copy link
Member

Summary

This entry was originally used to override the firmware filenames generated by the build server, but these days all filenames should match the board directory name. So, remove the "id" entry and let the default be used.

This is a follow-up to 1a99f74 (these three boards were added after that change).

Testing

No testing has been done. The change is hopefully self evident.

@dpgeorge
Copy link
Member Author

This was triggered by #16535 (comment)

@dpgeorge dpgeorge requested a review from projectgus January 14, 2025 05:48
Copy link
Contributor

@projectgus projectgus left a comment

Choose a reason for hiding this comment

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

Oh, I didn't notice this! Yes, this is better 😁

It looks like "id" is not used by other ports, either. Can we also remove support from build-board.sh, so that it can't creep back in?

@projectgus
Copy link
Contributor

Heads up for @UnexpectedMaker as well: no action required on your part after all.

@dpgeorge
Copy link
Member Author

It looks like "id" is not used by other ports, either. Can we also remove support from build-board.sh, so that it can't creep back in?

OK, I've now done that.

But note that you can still define "id", it'll just be overwritten (similar to "port" and "build" entries which are always populated/overwritten with defaults).

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.58%. Comparing base (0a9cc90) to head (d533c90).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #16584   +/-   ##
=======================================
  Coverage   98.58%   98.58%           
=======================================
  Files         167      167           
  Lines       21596    21596           
=======================================
  Hits        21291    21291           
  Misses        305      305           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

This entry was originally used to override the firmware filenames generated
by the build server, but these days all filenames should match the board
directory name.  So, remove the "id" entry and let the default be used.

This is a follow-up to 1a99f74 (these
three boards were added after that change).

Signed-off-by: Damien George <[email protected]>
All board IDs are now the board directory name.

Signed-off-by: Damien George <[email protected]>
@dpgeorge dpgeorge force-pushed the esp32-remove-remaining-board-json-id branch from ce55b01 to d533c90 Compare January 15, 2025 05:48
@dpgeorge dpgeorge merged commit d533c90 into micropython:master Jan 15, 2025
65 checks passed
@dpgeorge dpgeorge deleted the esp32-remove-remaining-board-json-id branch January 15, 2025 05:57
@mattytrentini
Copy link
Contributor

Tangentially related to this; A long time ago I looked at using json-schema to enforce the build.json format...is that something that would be useful?

(Additional checks - size of images, valid urls etc - have already begun to be integrated into mpbuild too.)

@dpgeorge
Copy link
Member Author

Tangentially related to this; A long time ago I looked at using json-schema to enforce the build.json format...is that something that would be useful?

If a check can be added to the CI here with minimal overhead and maintenance effort, then yes that could be good to have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants