fix(cli): standard log messages are sent to stderr when CI=true#20957
Merged
mergify[bot] merged 2 commits intoaws:mainfrom Jul 4, 2022
corymhall:corymhall/core/exportValue
Merged
fix(cli): standard log messages are sent to stderr when CI=true#20957mergify[bot] merged 2 commits intoaws:mainfrom corymhall:corymhall/core/exportValue
mergify[bot] merged 2 commits intoaws:mainfrom
corymhall:corymhall/core/exportValue
Conversation
The CLI currently sends almost all logs to `stderr`, even success messages. Based on the linked issue, this was done to make terminal colors easier to see. While this might make it easier for users that are running the CLI from their local machine, it causes issues on some CI systems that will exit if anything is written to `stderr` (even when the exit code is 0). This PR updates all of the logging mechanisms to recognize the `ci` argument. If `--ci` is passed, or the environment variable `CI=true` then all logs (except for error logs) will be sent to `stdout`. Currently the `ci` argument was only available on the `deploy` command, but this PR moves that to the global arguments list so that it will apply to all commands. I tested this manually on a CDK app by using a script to capture `stderr` and `stdout`. ```bash export CI=true key="$1" cmd="npx cdk deploy" errlog=$(mktemp) stdlog=$(mktemp) $cmd 1>> "$stdlog" 2> "$errlog" echo "-------------------errlog---------------------" cat "$errlog" echo "-------------------stdlog---------------------" cat "$stdlog" rm -f "$errlog" rm -f "$stdlog" ``` I also added new unit and integration tests that validate the change. fixes #7717
|
|
rix0rrr
approved these changes
Jul 4, 2022
Contributor
|
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). |
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
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). |
daschaa
pushed a commit
to daschaa/aws-cdk
that referenced
this pull request
Jul 9, 2022
…20957) The CLI currently sends almost all logs to `stderr`, even success messages. Based on the linked issue, this was done to make terminal colors easier to see. While this might make it easier for users that are running the CLI from their local machine, it causes issues on some CI systems that will exit if anything is written to `stderr` (even when the exit code is 0). This PR updates all of the logging mechanisms to recognize the `ci` argument. If `--ci` is passed, or the environment variable `CI=true` then all logs (except for error logs) will be sent to `stdout`. Currently the `ci` argument was only available on the `deploy` command, but this PR moves that to the global arguments list so that it will apply to all commands. I tested this manually on a CDK app by using a script to capture `stderr` and `stdout`. ```bash export CI=true key="$1" cmd="npx cdk deploy" errlog=$(mktemp) stdlog=$(mktemp) $cmd 1>> "$stdlog" 2> "$errlog" echo "-------------------errlog---------------------" cat "$errlog" echo "-------------------stdlog---------------------" cat "$stdlog" rm -f "$errlog" rm -f "$stdlog" ``` I also added new unit and integration tests that validate the change. fixes aws#7717 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The CLI currently sends almost all logs to
stderr, even successmessages. Based on the linked issue, this was done to make terminal
colors easier to see. While this might make it easier for users that are
running the CLI from their local machine, it causes issues on some CI
systems that will exit if anything is written to
stderr(even when theexit code is 0).
This PR updates all of the logging mechanisms to recognize the
ciargument. If
--ciis passed, or the environment variableCI=truethen all logs (except for error logs) will be sent to
stdout.Currently the
ciargument was only available on thedeploycommand,but this PR moves that to the global arguments list so that it will
apply to all commands.
I tested this manually on a CDK app by using a script to capture
stderrandstdout.I also added new unit and integration tests that validate the change.
fixes #7717
All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license