Skip to content

chore(cli): remove unused legacy deployment options#1269

Merged
aws-cdk-automation merged 1 commit intomainfrom
mrgrain/refactor/deployments/remove-legacy-deploy-options
Mar 27, 2026
Merged

chore(cli): remove unused legacy deployment options#1269
aws-cdk-automation merged 1 commit intomainfrom
mrgrain/refactor/deployments/remove-legacy-deploy-options

Conversation

@mrgrain
Copy link
Copy Markdown
Contributor

@mrgrain mrgrain commented Mar 27, 2026

This was made possible by the migration in #1250, which moved all callers to use deploymentMethod directly.

The DeployStackOptions interfaces in both deploy-stack.ts and deployments.ts still carried several deprecated properties that served as legacy compatibility shims, translating old-style options into the newer deploymentMethod parameter. Since all callers have been migrated to use deploymentMethod directly, these shims are no longer needed and the translation code was dead weight.

This removes the deprecated hotswap, hotswapPropertyOverrides, execute, changeSetName, and ignoreNoStacks properties from the internal deployment interfaces, along with the compatibility translation logic in Deployments.deployStack() and deployStack(). The CfnDeployOptions interface in the CLI's cdk-toolkit.ts is cleaned up accordingly, no longer passing the removed options through to Deployments.

Tests are updated to use deploymentMethod directly instead of the removed options.

Checklist

  • This change contains a major version upgrade for a dependency and I confirm all breaking changes are addressed
    • Release notes for the new version:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Remove deprecated `hotswap`, `hotswapPropertyOverrides`, `execute`,
`changeSetName`, and `ignoreNoStacks` options from `DeployStackOptions`
interfaces. These were legacy compatibility shims that translated old
options into the `deploymentMethod` parameter. All callers now use
`deploymentMethod` directly.

Update tests to use `deploymentMethod` instead of the removed options.
@mrgrain mrgrain changed the title refactor(deployments): remove deprecated legacy deployment options chore(cli): remove deprecated legacy deployment options Mar 27, 2026
@mrgrain mrgrain changed the title chore(cli): remove deprecated legacy deployment options chore(cli): remove unused legacy deployment options Mar 27, 2026
@github-actions github-actions bot added the p2 label Mar 27, 2026
@aws-cdk-automation aws-cdk-automation requested a review from a team March 27, 2026 12:43
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.11%. Comparing base (23bc301) to head (4f7b4a3).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1269      +/-   ##
==========================================
- Coverage   88.13%   88.11%   -0.03%     
==========================================
  Files          73       73              
  Lines       10379    10359      -20     
  Branches     1410     1410              
==========================================
- Hits         9148     9128      -20     
  Misses       1204     1204              
  Partials       27       27              
Flag Coverage Δ
suite.unit 88.11% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Mar 27, 2026
Merged via the queue into main with commit 815c7a3 Mar 27, 2026
61 of 62 checks passed
@aws-cdk-automation aws-cdk-automation deleted the mrgrain/refactor/deployments/remove-legacy-deploy-options branch March 27, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants