-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
esp32/boards: Remove remaining "id" entries from board.json. #16584
Conversation
This was triggered by #16535 (comment) |
There was a problem hiding this 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?
Heads up for @UnexpectedMaker as well: no action required on your part after all. |
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). |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Code size report:
|
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]>
ce55b01
to
d533c90
Compare
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.) |
If a check can be added to the CI here with minimal overhead and maintenance effort, then yes that could be good to have. |
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.