-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
refactor(toolkit): new message level result
#33234
Conversation
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.
(This review is outdated)
bea5564
to
988b621
Compare
988b621
to
4ec739c
Compare
Codecov ReportAttention: Patch coverage is
❌ Your patch status has failed because the patch coverage (91.30%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #33234 +/- ##
=======================================
Coverage 80.79% 80.79%
=======================================
Files 232 232
Lines 14106 14106
Branches 2452 2450 -2
=======================================
Hits 11397 11397
Misses 2429 2429
Partials 280 280
Flags with carried forward coverage won't be shown. Click here to find out more.
|
➡️ PR build request submitted to A maintainer must now check the pipeline and add the |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Comments on closed issues and PRs are hard for our team to see. |
Reason for this change
The CDK CLI has certain semantic rules around which messages are written to which output stream (
stdout
orstderr
). These rules are mostly generalizable based on the level of a message. However until now there was one major exception: The main results of a CLI command should always be written tostdout
, regardless of level. In practice these messages were always attributed to theinfo
level.With the recent refactorings towards a
CliIoHost
, we needed to include an additional propertyforceStdout
onIoMessages
. This always was a bad crutch and unintended to stay.Description of changes
Removal of the
forceStdout
message property, in favor of a new explicit message level:result
.In terms of priority, a
result
is lower than anerror
, but higher than awarn
. This is intuitive: A user that wants to ignore all warnings, will still want to see results.Use result in the CLU and the new Toolkit class.
Describe any new or updated permissions being added
n/a
Description of how you validated changes
Existing and extended tests.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license