Docs: Make clear that `Stack.dependsOn` does not create a depedency between stacks (`addDependency` does)

[aadhikary]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

cdktf & Language Versions

cdktf (0.10.4) typescript

Affected Resource(s)

Dependency between stacks

Debug Output

When stack2.dependsOn(stack1) then currently the stack dependency does not seem to work. This is not an issue if you are referencing Stack resource from stack1 into stack2. In resource reference case the stack seem to follow the order.

Expected Behavior

stack2 should deploy only after stack1

Actual Behavior

Race condition applies which causes any of the stack to deploy in any order.

NOTE

Stack addDependency method can be used to get around this.

[jsteinich]

stack2.dependsOn(stack1) just returns a boolean to indicate if stack2 depends on stack1. stack2.addDependency(stack1) is the way to indicate that stack2 should depend on stack1.

Perhaps a different name would make this more apparent, but I think just adding documentation would suffice.