fix(cli): pathMetadata and assetMetadata defaults cannot be configured in cdk.json #24533
Conversation
This file contains 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
github-actions
bot
added
the
beginning-contributor
github-actions
bot
added
bug
aws-cdk-automation
previously requested changes
Mar 9, 2023
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
aws-cdk-automation
added
the
pr/needs-cli-test-run
rix0rrr
changed the title
rix0rrr
added
pr-linter/exempt-test
Previously, pathMetadata, assetMetadata, debug and staging could not be set in `cdk.json`
as command-line parameters defaults would always overwrite this. In particular, this
`cdk.json` would be ignored:
```
{
"app": "npx ts-node --prefer-ts-exts bin/example",
...
"pathMetadata": false,
"assetMetadata": false
}
```
The issue is this piece of code:
```
this.settings = this.defaultConfig
.merge(userConfig)
.merge(this.projectConfig)
.merge(this.commandLineArguments)
.makeReadOnly();
```
`commandLineArguments` returns true for the above mentioned options. This commit is a copy
of aws#21891 which fell through the cracks, so I'm picking
up as this can potentially cause outages to resources that have drift under the hood, and
adding metadata looks like an `Update` operation to CloudFormation.
There are already unit tests around the cli which show that the same behavior works, located
here:
https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli.integtest.ts
fixes aws#3573
shoutout to @berenddeboer who did the work, I'm just reviving it.
rix0rrr
approved these changes
Mar 9, 2023
comcalvi
added
pr-linter/cli-integ-tested
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dissmissing 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). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
homakk
pushed a commit
to homakk/aws-cdk
that referenced
this pull request
Mar 28, 2023
…d in cdk.json (aws#24533) Previously, pathMetadata, assetMetadata, debug and staging could not be set in `cdk.json` as command-line parameters defaults would always overwrite this. In particular, this `cdk.json` would be ignored: ``` { "app": "npx ts-node --prefer-ts-exts bin/example", ... "pathMetadata": false, "assetMetadata": false } ``` The issue is this piece of code: ``` this.settings = this.defaultConfig .merge(userConfig) .merge(this.projectConfig) .merge(this.commandLineArguments) .makeReadOnly(); ``` `commandLineArguments` returns true for the above mentioned options. This commit is a copy of aws#21891 which fell through the cracks, so I'm picking up as this can potentially cause outages to resources that have drift under the hood, and adding metadata looks like an `Update` operation to CloudFormation. There are already unit tests around the cli which show that the same behavior works, located here: https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli.integtest.ts shoutout to @berenddeboer who did the work, I'm just reviving it. Closes aws#3573 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously, pathMetadata, assetMetadata, debug and staging could not be set in
cdk.jsonas command-line parameters defaults would always overwrite this. In particular, thiscdk.jsonwould be ignored:The issue is this piece of code:
commandLineArgumentsreturns true for the above mentioned options. This commit is a copy of #21891 which fell through the cracks, so I'm picking up as this can potentially cause outages to resources that have drift under the hood, and adding metadata looks like anUpdateoperation to CloudFormation.There are already unit tests around the cli which show that the same behavior works, located here:
https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli.integtest.ts
shoutout to @berenddeboer who did the work, I'm just reviving it.
Closes #3573
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license