From 5741a053cd73740e9612e69c13c443b4450a2631 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Thu, 14 Mar 2024 10:33:03 +0100 Subject: [PATCH] docs(maintenance): update v1 and v2 status --- docs/overrides/main.html | 2 +- docs/upgrade.md | 8 +++++++- docs/versioning.md | 4 +++- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 21efa64b87..67010de9bc 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -8,6 +8,6 @@ {% endblock %} {% block announce %} -Version 2 is coming soon 🔥 Check out the upgrade guide to see +Version 2 is generally available 🔥 Check out the upgrade guide to see what's new. {% endblock %} \ No newline at end of file diff --git a/docs/upgrade.md b/docs/upgrade.md index e09c68e33a..ab2d14be0c 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -3,6 +3,12 @@ title: Upgrade guide description: Guide to update between major Powertools for AWS Lambda (TypeScript) versions --- +## End of support v1 + +!!! warning "On March 13th, 2024, Powertools for AWS Lambda (TypeScript) v1 entered maintenance mode, and will reach end-of-life on September 1st, 2024. If you are still using v1, we strongly recommend you to read our upgrade guide and update to the latest version." + +Given our commitment to all of our customers using Powertools for AWS Lambda (TypeScript), we will keep npm v1 releases and documentation 1.x versions to prevent any disruption. + ## Migrate from v1 to v2 V2 is focused on official support for ESM (ECMAScript modules). We've made other minimal breaking changes to make your transition to v2 as smooth as possible. @@ -10,7 +16,7 @@ V2 is focused on official support for ESM (ECMAScript modules). We've made other ### Quick summary | Area | Change | Code change required | -| --------------------- |--------------------------------------------------------------------------------------------------------------------------------| -------------------- | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | | **ESM support** | Added ESM support via dual CommonJS and ESM bundling, enabling top-level `await` and tree-shaking. | - | | **Middy.js** | Updated import path for Middy.js middlewares to leverage subpath exports - i.e. `@aws-lambda-powertools/tracer/middleware`. | Yes | | **Types imports** | Updated import path for TypeScript types to leverage subpath exports - i.e. `@aws-lambda-powertools/logger/types`. | Yes | diff --git a/docs/versioning.md b/docs/versioning.md index c8055f59f7..f747e90c6d 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -59,5 +59,7 @@ To see the list of available major versions of Powertools for AWS Lambda and whe | SDK | Major version | Current Phase | General Availability Date | Notes | | ------------------------------------ | ------------- | ------------------------ | ------------------------- | ------------------------------------------------------------------------------------------------------- | -| Powertools for AWS Lambda TypeScript | 1.x | Maintenance Announcement | 07/15/2022 | See [v2 RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1714) | +| Powertools for AWS Lambda TypeScript | 1.x | End-of-life | 09/01/2024 | See [announcement](https://github.com/aws-powertools/powertools-lambda-typescript/issues/2224) | +| Powertools for AWS Lambda TypeScript | 1.x | Maintenance Announcement | 03/13/2024 | See [announcement](https://github.com/aws-powertools/powertools-lambda-typescript/issues/2224) | +| Powertools for AWS Lambda TypeScript | 2.x | General Availability | 03/05/2024 | See [Release Notes](https://github.com/aws-powertools/powertools-lambda-typescript/releases/tag/v2.0.0) | | Powertools for AWS Lambda TypeScript | 1.x | General Availability | 07/15/2022 | See [Release Notes](https://github.com/aws-powertools/powertools-lambda-typescript/releases/tag/v1.0.0) |