fix(cli): stop cli argument defaults from overriding cdk.json settings #21891
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
|
|
|
Linter fails saying a fix should make a change to a test file, unfortunately there was no test file that tests command-line parsing and integration with cdk.json. |
berenddeboer
changed the title
aws-cdk-automation
requested changes
Oct 21, 2022
|
Running through the test pipeline. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
corymhall
added
the
pr-linter/cli-integ-tested
|
This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
|
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
aws-cdk-automation
added
the
closed-for-staleness
|
The pull request linter fails with the following errors: PRs must pass status checks before we can provide a meaningful review. |
|
Could we get this reopened? |
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
iph
pushed a commit
to iph/aws-cdk
that referenced
this pull request
Mar 9, 2023
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.
mergify bot
pushed a commit
that referenced
this pull request
Mar 22, 2023
…d in cdk.json (#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 #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 #3573 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
This PR fixes the problems mentioned in #3573. 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:{ "app": "npx ts-node --prefer-ts-exts bin/example", ... "pathMetadata": false, "assetMetadata": false }The issue is this piece of code:
commandLineArgumentsreturns true for the above mentioned options.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