From 698f79b91bd7cbe797add3facc3de8fdfea4a703 Mon Sep 17 00:00:00 2001 From: Kendra Neil <53584728+TheRealAmazonKendra@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:18:04 -0700 Subject: [PATCH] docs: add end-of-life schedule to README --- .projen/tasks.json | 2 +- .projenrc.ts | 2 +- README.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 2 deletions(-) diff --git a/.projen/tasks.json b/.projen/tasks.json index 2f2e325..c2d9d04 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -109,7 +109,7 @@ "description": "Runs eslint against the codebase", "steps": [ { - "exec": "eslint --ext .ts,.tsx --fix --no-error-on-unmatched-pattern $@ src test bin build-tools projenrc .projenrc.ts", + "exec": "eslint --ext .ts,.tsx --fix --no-error-on-unmatched-pattern $@ test bin lib build-tools projenrc .projenrc.ts", "receiveArgs": true } ] diff --git a/.projenrc.ts b/.projenrc.ts index 87aae11..81f208d 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -40,7 +40,7 @@ const project = new typescript.TypeScriptProject({ packageName: 'cdk-assets', eslintOptions: { prettier: true, - dirs: ['src', 'test', 'bin'], + dirs: ['test', 'bin', 'lib'], }, jestOptions: { jestConfig: { diff --git a/README.md b/README.md index f418995..dfdad10 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,34 @@ A tool for publishing CDK assets to AWS environments. + + +--- + +> The AWS SDK for JavaScript v2 will enter maintenance mode on September 8, 2024 +> and will reach end-of-support on September 8, 2025. +> +> The implementation of DefaultAwsClient in cdk-assets is tightly coupled to v2 of the AWS JavaScript SDK and, +> as such, will follow the same end-of-life schedule. +> Existing applications that use cdk-assets v2 will continue to function as +> intended, unless there is a fundamental change to any of the AWS services with client wrappers. +> +> cdk-assets v2 will not be updated to support any new AWS services, new features, +> or any changes to existing services. +> +> cdk-assets v3 now has an available release candidate that uses AWS SDK for JavaScript v3 and will be stabilized prior to v2 being put into maintenance mode. +> +> The following table outlines the future level of support for v2: +> +| Lifecycle Phase | Start Date | End Date | Support Level | +| :---------------: |:------: | :------: | :------: | +| Maintenance Mode | September 8, 2024 | September 7, 2025 | cdk-assets v2 will limit releases to address critical bug fixes, security issues, and dependency upgrades. No new features or non-critical bug fixes will be addressed. | +| End-Of-Support | September 8, 2025 | N/A | cdk-assets v2 will no longer receive updates or releases. Previously published releases will continue to be available via npm and the code will remain on GitHub. | + +--- + + + ## Overview `cdk-assets` requires an asset manifest file called `assets.json`, in a CDK