Skip to content

feat(cx-api): declare support for CDK_TOOLKIT_VERSION env var #33963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2025
Merged

feat(cx-api): declare support for CDK_TOOLKIT_VERSION env var #33963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9ca4e1
feat(cx-api): declare support for CDK_TOOLKIT_VERSION env var
mrgrain Mar 28, 2025
b4ad8a6
Merge branch 'main' into mrgrain/feat/toolkit-env-version
mergify[bot] Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion packages/aws-cdk-lib/cx-api/lib/cxapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ export const DEFAULT_ACCOUNT_ENV = 'CDK_DEFAULT_ACCOUNT';
export const DEFAULT_REGION_ENV = 'CDK_DEFAULT_REGION';

/**
* Version of Cloud Assembly expected by CDK CLI.
* Version of Cloud Assembly expected by CDK Toolkit.
*
* Despite it's name, this value applies to all version of the CDK Toolkit, not just the CLI.
*
* CLI started emitting this at 1.10.1
*/
Expand All @@ -30,9 +32,17 @@ export const CLI_ASM_VERSION_ENV = 'CDK_CLI_ASM_VERSION';
* Version of the CLI currently running.
*
* CLI started emitting this at 1.10.1
* Will not be present if the CDK app is run by any Toolkit variation other than the CLI.
*/
export const CLI_VERSION_ENV = 'CDK_CLI_VERSION';

/**
* Package & version of the CDK Toolkit running the app.
*
* In the format "<package>@x.y.z", e.g "[email protected]" or "@aws-cdk/[email protected]"
*/
export const TOOLKIT_VERSION_ENV = 'CDK_TOOLKIT_VERSION';

/**
* If a context value is an object with this key, it indicates an error
*/
Expand Down