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): Allow specifying options using env vars #1447

Merged
merged 1 commit into from
Dec 28, 2018

Conversation

RomainMuller
Copy link
Contributor

@RomainMuller RomainMuller commented Dec 28, 2018

Allows passing options to the cdk command using environment variables
with the CDK_ name prefix. This can be used, for example, for the
following:

  • CDK_VERSION_REPORTING=false disables version reporting
  • CDK_REQUIRE_APPROVAL=broadening requires approval for changes to
    security policies that broaden the grants
  • CDK_VERBOSE=true enables verbose logging in the toolkit

Added a validator in cdk doctor that will display the environment
variables that may be picked up by the toolkit, and highlight those that
are reserved for internal use by the toolkit (CDK_CONTEXT_JSON and
CDK_OUTDIR).


Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: manually run integration tests and paste output as a PR comment
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

Allows passing options to the `cdk` command using environment variables
with the `CDK_` name prefix. This can be used, for example, for the
following:

- `CDK_VERSION_REPORTING=false` disables version reporting
- `CDK_REQUIRE_APPROVAL=broadening` requires approval for changes to
  security policies that broaden the grants
- `CDK_VERBOSE=true` enables verbose logging in the toolkit

Added a validator in `cdk doctor` that will display the environment
variables that may be picked up by the toolkit, and highlight those that
are reserved for internal use by the toolkit (`CDK_CONTEXT_JSON` and
`CDK_OUTDIR`).
@RomainMuller RomainMuller requested a review from a team as a code owner December 28, 2018 15:00
@RomainMuller RomainMuller added enhancement package/tools Related to AWS CDK Tools or CLI labels Dec 28, 2018
@RomainMuller RomainMuller merged commit 7cd84a0 into master Dec 28, 2018
@RomainMuller RomainMuller deleted the rmuller/allow-env-config branch December 28, 2018 15:12
@srchase srchase added feature-request A feature should be added or improved. and removed enhancement labels Jan 3, 2019
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
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. feature-request A feature should be added or improved. package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants