Skip to content

docs(v2): Create upgrade guide and versioning policy #1856

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.

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

Open
wants to merge 28 commits into
base: v2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
678cd5f
Update docs requirements using pip-compile. Add privacy plugin. Add l…
phipag Apr 10, 2025
ea43772
Add roadmap.
phipag Apr 11, 2025
3115ba7
Fix outdated AspectJ configuration in documentation pages.
phipag Apr 11, 2025
2c380c7
Synchronize Changelog with recent releases.
phipag Apr 11, 2025
1dbea5e
Add llms.txt to links to navbar.
phipag Apr 14, 2025
d347829
Add Versioning policy page.
phipag Apr 22, 2025
4d4400f
Update site url in mkdocs.yml.
phipag Apr 25, 2025
e425e51
Merge branch 'v2' into phipag/docs-v2
phipag Apr 25, 2025
5d3dd53
Add versioning.md to llms.txt.
phipag Apr 25, 2025
bc6326a
Merge branch 'v2' into phipag/docs-v2
phipag May 9, 2025
d1045b7
Merge branch 'v2' into phipag/docs-v2
phipag May 20, 2025
1119f03
Update maintainers.md.
phipag May 20, 2025
fa49ab4
Fix formatting.
phipag May 20, 2025
444f6d9
Fix formatting.
phipag May 20, 2025
875506f
Add upgrade guide.
phipag May 21, 2025
54d8b23
Update docs/upgrade.md
dreamorosi May 22, 2025
10b7ecc
Update docs/upgrade.md
dreamorosi May 22, 2025
bdf42e1
Update docs/upgrade.md
dreamorosi May 22, 2025
a75c346
Update docs/upgrade.md
dreamorosi May 22, 2025
6524154
Update docs/upgrade.md
dreamorosi May 22, 2025
3abafb6
Update docs/upgrade.md
dreamorosi May 22, 2025
8c78ed1
Update docs/upgrade.md
dreamorosi May 22, 2025
013ebfb
Update docs/upgrade.md
dreamorosi May 22, 2025
0de7879
Update docs/processes/maintainers.md
dreamorosi May 22, 2025
f8e7bd8
Update docs/upgrade.md
dreamorosi May 22, 2025
d0c5b07
Update docs/processes/maintainers.md
dreamorosi May 22, 2025
2925c45
Update docs/upgrade.md
dreamorosi May 22, 2025
0699f8b
Update docs/upgrade.md
dreamorosi May 22, 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
22 changes: 12 additions & 10 deletions docs/processes/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,23 @@ This is document explains who the maintainers are, their responsibilities, and h

## Current Maintainers

| Maintainer | GitHub ID | Affiliation |
|-----------------------|---------------------------------------------------------------------------------| ----------- |
| Jerome Van Der Linden | [jeromevdl](https://github.com/jeromevdl){target="_blank"} | Amazon |
| Michele Ricciardi | [mriccia](https://github.com/mriccia){target="_blank"} | Amazon |
| Scott Gerring | [scottgerring](https://github.com/scottgerring){target="_blank"} | Amazon |
| Maintainer | GitHub ID | Affiliation |
| --------------- | -------------------------------------------------------------------- | ----------- |
| Philipp Page | [phipag](https://github.com/phipag){target="\_blank" rel="nofollow"} | Amazon |
| Simon Thulbourn | [sthulb](https://github.com/sthulb){target="\_blank" rel="nofollow"} | Amazon |

## Emeritus

Previous active maintainers who contributed to this project.

| Maintainer | GitHub ID | Affiliation |
|----------------|-----------------------------------------------------------------------------------------|---------------|
| Mark Sailes | [msailes](https://github.com/msailes){target="_blank"} | Amazon |
| Pankaj Agrawal | [pankajagrawal16](https://github.com/pankajagrawal16){target="_blank"} | Former Amazon |
| Steve Houel | [stevehouel](https://github.com/stevehouel) | Amazon |
| Maintainer | GitHub ID | Affiliation |
| --------------------- | -------------------------------------------------------------------------------------- | ------------- |
| Jerome Van Der Linden | [jeromevdl](https://github.com/jeromevdl){target="\_blank" rel="nofollow"} | Amazon |
| Michele Ricciardi | [mriccia](https://github.com/mriccia){target="\_blank" rel="nofollow"} | Amazon |
| Scott Gerring | [scottgerring](https://github.com/scottgerring){target="\_blank" rel="nofollow"} | DataDog |
| Mark Sailes | [msailes](https://github.com/msailes){target="\_blank" rel="nofollow"} | N/A |
| Pankaj Agrawal | [pankajagrawal16](https://github.com/pankajagrawal16){target="\_blank" rel="nofollow"} | Former Amazon |
| Steve Houel | [stevehouel](https://github.com/stevehouel){target="\_blank" rel="nofollow"} | Amazon |

## Labels

Expand Down
60 changes: 60 additions & 0 deletions docs/processes/versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Versioning and maintenance policy
description: Versioning and maintenance policy for Powertools for AWS Lambda (Python)
---

### Overview

This document outlines the maintenance policy for Powertools for AWS Lambda and their underlying dependencies. AWS regularly provides Powertools for AWS Lambda with updates that may contain new features, enhancements, bug fixes, security patches, or documentation updates. Updates may also address changes with dependencies, language runtimes, and operating systems. Powertools for AWS Lambda is published to package managers (e.g. PyPi, NPM, Maven, NuGet), and are available as source code on GitHub.

We recommend users to stay up-to-date with Powertools for AWS Lambda releases to keep up with the latest features, security updates, and underlying dependencies. Continued use of an unsupported Powertools for AWS Lambda version is not recommended and is done at the user’s discretion.

!!! info "For brevity, we will interchangeably refer to Powertools for AWS Lambda as "SDK" _(Software Development Toolkit)_."

### Versioning

Powertools for AWS Lambda release versions are in the form of X.Y.Z where X represents the major version. Increasing the major version of an SDK indicates that this SDK underwent significant and substantial changes to support new idioms and patterns in the language. Major versions are introduced when public interfaces _(e.g. classes, methods, types, etc.)_, behaviors, or semantics have changed. Applications need to be updated in order for them to work with the newest SDK version. It is important to update major versions carefully and in accordance with the upgrade guidelines provided by AWS.

### SDK major version lifecycle

The lifecycle for major Powertools for AWS Lambda versions consists of 5 phases, which are outlined below.

- **Developer Preview** (Phase 0) - During this phase, SDKs are not supported, should not be used in production environments, and are meant for early access and feedback purposes only. It is possible for future releases to introduce breaking changes. Once AWS identifies a release to be a stable product, it may mark it as a Release Candidate. Release Candidates are ready for GA release unless significant bugs emerge, and will receive full AWS support.
- **General Availability (GA)** (Phase 1) - During this phase, SDKs are fully supported. AWS will provide regular SDK releases that include support for new features, enhancements, as well as bug and security fixes. AWS will support the GA version of an SDK for _at least 24 months_, unless otherwise specified.
- **Maintenance Announcement** (Phase 2) - AWS will make a public announcement at least 6 months before an SDK enters maintenance mode. During this period, the SDK will continue to be fully supported. Typically, maintenance mode is announced at the same time as the next major version is transitioned to GA.
- **Maintenance** (Phase 3) - During the maintenance mode, AWS limits SDK releases to address critical bug fixes and security issues only. An SDK will not receive API updates for new or existing services, or be updated to support new regions. Maintenance mode has a _default duration of 6 months_, unless otherwise specified.
- **End-of-Support** (Phase 4) - When an SDK reaches end-of support, it will no longer receive updates or releases. Previously published releases will continue to be available via public package managers and the code will remain on GitHub. The GitHub repository may be archived. Use of an SDK which has reached end-of-support is done at the user’s discretion. We recommend users upgrade to the new major version.

!!! note "Please note that the timelines shown below are illustrative and not binding"

![Maintenance policy timelines](https://docs.aws.amazon.com/images/sdkref/latest/guide/images/maint-policy.png)

### Dependency lifecycle

Most AWS SDKs have underlying dependencies, such as language runtimes, AWS Lambda runtime, or third party libraries and frameworks. These dependencies are typically tied to the language community or the vendor who owns that particular component. Each community or vendor publishes their own end-of-support schedule for their product.

The following terms are used to classify underlying third party dependencies:

- [**AWS Lambda Runtime**](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html): Examples include `java17`, `nodejs20.x`, `python3.13`, etc.
- **Language Runtime**: Examples include Java 17, Python 3.13, NodeJS 20, .NET Core, etc.
- **Third party Library**: Examples include Jackson Project, AWS X-Ray SDK, AWS Encryption SDK, etc.

Powertools for AWS Lambda follows the [AWS Lambda Runtime deprecation policy cycle](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy), when it comes to Language Runtime. This means we will stop supporting their respective deprecated Language Runtime _(e.g., `java8`)_ without increasing the major SDK version.

!!! note "AWS reserves the right to stop support for an underlying dependency without increasing the major SDK version"

### Communication methods

Maintenance announcements are communicated in several ways:

- A pinned GitHub Request For Comments (RFC) issue indicating the campaign for the next major version. The RFC will outline the path to end-of-support, specify campaign timelines, and upgrade guidance.
- AWS SDK documentation, such as API reference documentation, user guides, SDK product marketing pages, and GitHub readme(s) are updated to indicate the campaign timeline and provide guidance on upgrading affected applications.
- Deprecation warnings are added to the SDKs, outlining the path to end-of-support and linking to the upgrade guide.

To see the list of available major versions of Powertools for AWS Lambda and where they are in their maintenance lifecycle, see the [version support matrix](#version-support-matrix).

### Version support matrix

| SDK | Major version | Current Phase | General Availability Date | Notes |
| -------------------------------- | ------------- | -------------------- | ------------------------- | ------------------------------------------------------------------------------------------------- |
| Powertools for AWS Lambda (Java) | 1.x | General Availability | 11/04/2020 | See [Release notes](https://github.com/aws-powertools/powertools-lambda-java/releases/tag/v1.0.0) |
Loading
Loading