Skip to content

docs(maintenance): update v1 and v2 status #2226

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 1 commit into from
Mar 14, 2024
Merged

docs(maintenance): update v1 and v2 status #2226

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 docs/overrides/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
{% endblock %}

{% block announce %}
Version 2 is coming soon 🔥 Check out the <a href="{{ '../' ~ base_url ~ '/latest/upgrade' }}">upgrade guide</a> to see
Version 2 is generally available 🔥 Check out the <a href="{{ '../' ~ base_url ~ '/latest/upgrade' }}">upgrade guide</a> to see
what's new.
{% endblock %}
8 changes: 7 additions & 1 deletion docs/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@ 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.

### 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 |
Expand Down
4 changes: 3 additions & 1 deletion docs/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |