search

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.57k stars 3.88k forks source link

Deploy --hotswap : Fallback Option undocumented #24639

Open ADataGMan opened 1 year ago

ADataGMan commented 1 year ago

Describe the issue

A recent change, https://github.com/aws/aws-cdk/pull/23653, has modified the behavior of hotswap, and broken scripts to deploy stacks in a non-production use case.

There appears to be behavior to address this added in the same CR, "--hotswap-fallback", but the only documentation of this flag existing that I've been able to find is on the CR, and people who have copied the notes from the CR. It is not available if I call cdk deploy --help although --hotswap is listed.

Links

https://github.com/aws/aws-cdk/pull/23653 https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-help cdk deploy --help

I can't actually link to the documentation because I can't find any AWS documentation for the CLI beyond the very top level commands. This is a terrible experience for someone trying to research how to work with these technologies, and at the scale of Amazon this is not not living up to the leadership principles I expect.

khushail commented 1 year ago

Hi @ADataGMan , thanks for reaching out. Although the read me is updated here link has the information about cdk deply -- fallback, I am not really sure about your ask here. Are you looking for documentation updates to CLI commands? It would be great if you could clarify your ask here.

pahud commented 1 year ago

Hi @ADataGMan

The --hotswap-fallback is described in the README and you can also see its usage when you run cdk deploy --help:

image

Is this what you are looking for?

ADataGMan commented 1 year ago

@pahud That is exactly what I was looking for, but this is what I see when I run the help command.

image

At this point it seems like a user issue however as clearly the latest version does document it, and the change in behavior within my system must be a dependency I didn't realize was different.

I still wish these commands were documented within the existing Amazon documentation pages for the lower level commands as trying to discover this when you don't realize things may have updated within your environment makes it difficult to discover. It also makes it more difficult to share that documentation at scale, such as you posting the helpful screenshot that addressed this.

Thank you for your help,

Aaron

pahud commented 1 year ago

Thank you @ADataGMan

I am making this a feature request for doc improvement. At this moment you can always run cdk deploy --help to see more details for cdk deploy.