cli: Respect --build option in cdk.json as well

[acomagu]

Describe the feature

The --build option was introduced for cdk deploy or cdk watch command at #19663, but the equivalent field in cdk.json is not introduced.

This issue proposes to support build field to cdk.json as well as --build flag.

Use Case

Rather than add --build ./build.sh flag each time executing cdk deploy, it's convenient if we could write the build command to cdk.json, like

{
  "app": "...",
  "build": "./build.sh"
}

Proposed Solution

Support build field in cdk.json.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.165.0

Environment details (OS name and version, etc.)

Linux acm-envy3-win 5.15.167.4-microsoft-standard-WSL2 #1 SMP Tue Nov 5 00:21:55 UTC 2024 x86_64 GNU/Linux

[ashishdhingra]

Appears to be valid feature request to support build option in cdk.json, similar to other options like app and versionReporting. Team could review if there are any concerns to support build key in cdk.json.

@acomagu Feel free to contribute PR that could be reviewed by the team. They should get back to you in case of any concerns or review comments.

[acomagu]

@ashishdhingra Thank you for your insight! Unfortunately I won't be able to start working on PR in at least a week, but I intend to do it sooner or later.

But I also don't intend to prevent others from make PR.

[tmokmss]

Afaik this feature has already been available via cdk.json.

edit) found the PR: #17176. It seems ~/cdk.json (user config) is not supported though. Is this the feature you need?

[ashishdhingra]

Afaik this feature has already been available via cdk.json.

edit) found the PR: #17176. It seems ~/cdk.json (user config) is not supported though. Is this the feature you need?

@tmokmss Thanks for your reply. Unsure if this is documented in CDK guide.

@acomagu Could you please give it a try and if it works, kindly close the issue.

[tmokmss]

@ashishdhingra I found this doc somewhat relevant:

You can pass options through command-line arguments. For most options, you can configure them in a cdk.json configuration file.
https://docs.aws.amazon.com/cdk/v2/guide/ref-cli-cmd.html#ref-cli-cmd-configure

But the problem is that it is not clear what most options are 😓

[rix0rrr]

Thanks for the feedback. I'll pass this note along for considerations of consistency for some upcoming work.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.