Skip to content
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

feat(cli): control progress output style with --progress=bar|events #9623

Merged
merged 9 commits into from
Aug 27, 2020

Conversation

shivlaks
Copy link
Contributor

@shivlaks shivlaks commented Aug 12, 2020

Since the new deployment monitoring has been problematic on environments such as CI,
adding a switch called progress to allow users to set their deploy output display preference.

Supported values are bar and events. The default deployment display mode includes the
progress bar.

The workaround of adding -v to display the stack event history includes a lot of
undesired output and users have expressed that it includes a lot of noise.

If the key progress exists in user settings (~/.cdk.json) or project settings (cdk.json),
users will not need to specify it on every deploy and can set their desired default once.

closes #8696


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@shivlaks shivlaks added the package/tools Related to AWS CDK Tools or CLI label Aug 12, 2020
@shivlaks shivlaks requested review from rix0rrr and a team August 12, 2020 08:55
@shivlaks shivlaks self-assigned this Aug 12, 2020
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Aug 12, 2020
@eladb
Copy link
Contributor

eladb commented Aug 12, 2020

To improve discoverability of the various options and allow future modes let's use an enumeration:

--progress=bar (current behavior)
--progress=events (old behavior)

@eladb eladb changed the title feat(cli): add a switch to display all stack events feat(cli): control progress output style with --progress=bar|events Aug 27, 2020
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

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

Update PR description to reflect updated switch name

@eladb eladb added the pr/do-not-merge This PR should not be merged at this time. label Aug 27, 2020
@eladb
Copy link
Contributor

eladb commented Aug 27, 2020

Added do-not-merge

@shivlaks shivlaks added pr-linter/exempt-test The PR linter will not require test changes and removed pr/do-not-merge This PR should not be merged at this time. labels Aug 27, 2020
@mergify
Copy link
Contributor

mergify bot commented Aug 27, 2020

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: f3bcf75
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Aug 27, 2020

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@robertd
Copy link
Contributor

robertd commented Sep 4, 2020 via email

@farzad-xgen
Copy link

Got it, thanks!

@robertd
Copy link
Contributor

robertd commented Sep 4, 2020

@shivlaks Can you please provide an example on how to set this in ~/.cdk.json globally? I can't seem to get it right.

Thanks!

@robertd
Copy link
Contributor

robertd commented Jan 13, 2021

@shivlaks poke

Edit: My apologies... figured it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. package/tools Related to AWS CDK Tools or CLI pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CLI] display issues with new deployment monitoring in the CDK CLI
5 participants