(cli): deploy and destroy with `--all` option fails on apps with no top-level stacks

[go-to-k]

Describe the bug

When running cdk destroy --all or cdk deploy --all against a configuration with no top-level stacks (nested stages only), the following error occurs.

const app = new cdk.App();

new MyStage(app, 'MyStage'); // This has CdkSampleStack

> cdk deploy
Since this app includes more than a single stack, specify which stacks to use (wildcards are supported) or specify `--all`
Stacks: MyStage/CdkSampleStack

> cdk deploy --all # exits with status code 1 (error)
...
No stack found in the main cloud assembly. Use "list" to print manifest

> cdk destroy --all # exits with status code 1 (error)
...
No stack found in the main cloud assembly. Use "list" to print manifest

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

It can deploy/destroy all the stacks, or no errors occur, or a correct message / documentation is needed.

Current Behavior

It doesn't deploy/destroy all the stacks, and it exits with status code 1 (error).

Reproduction Steps

const app = new cdk.App();

new MyStage(app, 'MyStage'); // This has CdkSampleStack

export class MyStage extends Stage {
  constructor(scope: Construct, id: string, props?: StageProps) {
    super(scope, id, props);

    new CdkSampleStack(this, 'CdkSampleStack');
  }
}

> cdk deploy --all

> cdk destroy --all

Possible Solution

• Make it deployable / destroyable
• Or any of the following approaches:
  • Prevent errors
  • Correct messages
  • Correct documentation

Additional Information/Context

No response

CDK CLI Version

2.1100.1

Framework Version

No response

Node.js Version

24

OS

mac

Language

TypeScript

Language Version

No response

Other information

Is this a bug or by design?

The error message by cdk deploy/destroy (without --all) on the app

Since this app includes more than a single stack, specify which stacks to use (wildcards are supported) or specify --all

Since it says specify --all on the command, it may not be by design, or this message may not be appropriate.

Code

The --all option says that Deploy all available stacks or Deploy all stacks.

see: https://github.com/aws/aws-cdk-cli/blob/cdk%40v2.1100.1/packages/aws-cdk/lib/cli/cli-config.ts#L141

see: https://github.com/aws/aws-cdk-cli/blob/cdk%40v2.1100.1/packages/%40aws-cdk/cloud-assembly-schema/lib/integ-tests/commands/common.ts#L34-L41

'all': { type: 'boolean', desc: 'Deploy all available stacks', default: false },

  /**
   * Deploy all stacks
   *
   * Requried if `stacks` is not set
   *
   * @default - false
   */
  readonly all?: boolean;

The --all is passed into allTopLevel.

see: https://github.com/aws/aws-cdk-cli/blob/cdk%40v2.1100.1/packages/aws-cdk/lib/cli/cli.ts#L244

    const selector: StackSelector = {
      allTopLevel: args.all,
      patterns: args.STACKS,
    };

But the allTopLevel says that all stacks at the top level assembly. Looking at the doc, it seems like this is by design.

see: https://github.com/aws/aws-cdk-cli/blob/cdk%40v2.1100.1/packages/aws-cdk/lib/cxapp/cloud-assembly.ts#L80

export interface StackSelector {
  /**
   * Whether all stacks at the top level assembly should
   * be selected and nothing else
   */
  allTopLevel?: boolean;

There also appears to be a test that verifies this.

see: https://github.com/aws/aws-cdk-cli/blob/cdk%40v2.1100.1/packages/aws-cdk/test/cxapp/cloud-assembly.test.ts#L7-L18

test('select all top level stacks in the presence of nested assemblies', async () => {
  // GIVEN
  const cxasm = await testNestedCloudAssembly();

  // WHEN
  const x = await cxasm.selectStacks({ allTopLevel: true, patterns: [] }, { defaultBehavior: DefaultSelection.AllStacks });

  // THEN
  expect(x.stackCount).toBe(2);
  expect(x.stackIds).toContain('witherrors');
  expect(x.stackIds).toContain('withouterrors');
});

If it is by design

However, if it is by design that the Stage stacks cannot be deployed or deleted with --all, it is a bit confusing.

There is no documentation to understand that, and the error message says to specify --all. Furthermore, it seems like a bug that it terminates abnormally instead of normally.

Isn't some kind of action necessary?

[pahud]

Hi @go-to-k,

Thanks for the detailed report and for already submitting PR #985 to address this!

Workaround until the fix lands:

cdk deploy '**'           # All stacks including nested
cdk deploy 'MyStage/*'    # All stacks in MyStage

The team will review PR #985 when it's ready and provide feedback there.

[mrgrain]

See #985 (review)

[mrgrain]

I get that the behavior of cdk deploy --all is confusing when using stages. But what would the actually desired behavior look like when using multiple stages? For example in the snippet below, sShould --all really deploy all three stages? I find that quire unhelpful.

const app = new cdk.App();

new MyStage(app, 'MyStage1'); 
new MyStage(app, 'MyStage2'); 
new MyStage(app, 'MyStage3'); 

Maybe we could have a --stage MyStage1 flag that behaves like MyStage1/**. We can then maybe make the error message of --all more intelligent to detect stages.

We could also have --all-stages, though I'm not convinced this has a real use case.

[go-to-k]

I didn't necessarily want to make this change. I just felt uneasy about the fact that executing the command as per the output message resulted in an error termination, and wanted to confirm the intent of the specifications.

I think it would be good to change the message, but I also understand that doing so requires some complex modifications. Therefore, I'm closing this issue for now.