Skip to content
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

chore: add end-of-life schedule to README #53

Merged
merged 1 commit into from
Aug 29, 2024
Merged

chore: add end-of-life schedule to README #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .projen/tasks.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .projenrc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,34 @@

A tool for publishing CDK assets to AWS environments.

<!--BEGIN STABILITY BANNER-->

---

> 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. |

---

<!--END STABILITY BANNER-->

## Overview

`cdk-assets` requires an asset manifest file called `assets.json`, in a CDK
Expand Down
Loading