-
Notifications
You must be signed in to change notification settings - Fork 293
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
Warn if project.toml contains keys not supported by schema #2042
Warn if project.toml contains keys not supported by schema #2042
Conversation
- also notifies when the schema version is missing and defaults to `0.1` Fixes buildpacks#1922 Signed-off-by: Colin Casey <casey.colin@gmail.com>
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #2042 +/- ##
==========================================
+ Coverage 79.66% 79.69% +0.03%
==========================================
Files 176 176
Lines 13231 13249 +18
==========================================
+ Hits 10539 10557 +18
Misses 2022 2022
Partials 670 670
Flags with carried forward coverage won't be shown. Click here to find out more. |
Signed-off-by: Colin Casey <casey.colin@gmail.com>
Signed-off-by: Colin Casey <casey.colin@gmail.com>
Thank you for implementing this! It's caught several people out (myself included), so looking forward to the better UX here :-) |
Signed-off-by: Juan Bustamante <juan.bustamante@broadcom.com>
Signed-off-by: Juan Bustamante <bustamantejj@gmail.com>
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.
Thanks a lot for this PR @colincasey, just a quick suggestion with the use of fmt
Signed-off-by: Juan Bustamante <bustamantejj@gmail.com>
Signed-off-by: Juan Bustamante <bustamantejj@gmail.com>
Signed-off-by: Colin Casey <casey.colin@gmail.com>
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.
Thank you @colincasey
Summary
As detailed in #1922, a common source of confusion with
project.toml
is failing to declare theschema-version
. Theschema-version
then silently defaults to0.1
which can lead to confusing and hard to debug errors when the user is using keys from the0.2
schema.This PR adds messaging to the build output notifying the user if:
0.1
Output
Before
After
Documentation
Related
Resolves #1922