Skip to content

(aws-cdk): cdk deploy documentation doesn't mention concurrent deploys #14344

@shellscape

Description

@shellscape

I opened #14316 recently, which was unceremoniously closed without further discussion around the crux of the problem. As @rix0rrr mentioned, there's a workaround for that particular problem, and his response would suggest that this is a known limitation of the framework at the moment.

Looking into the documentation in this repo, I can only find one mention of the flag here: https://github.com/aws/aws-cdk/tree/master/packages/aws-cdk#externally-executable-cloudformation-change-sets, which is a completely separate context and doesn't mention concurrent deployments via cdk deploy. #13024 added --change-set-name to the CLI, but the documentation doesn't mention other use cases for this flag.

The developer guide makes no mention of this flag, nor concurrent/parallel deployments https://docs.aws.amazon.com/cdk/latest/guide/cli.html and I'll raise a separate issue with them, pointing here.

This is a pretty big gap in the docs, and I'm honestly surprised that it hasn't been raised before with the increased commonality of monorepos for services and backend management. I'd like to suggest adding documentation to the README outlining known issues with parallel deployments, and pointing to using the --change-set-name flag to resolve the problem mentioned in the original bug issue.


This is a 📕 documentation issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThis is a problem with documentation.effort/smallSmall work item – less than a day of effortfeature-requestA feature should be added or improved.p2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions