Skip to content

docs(proccess): add versioning and maintenance policy #3682

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 8 commits into from
Jan 31, 2024
Merged

docs(proccess): add versioning and maintenance policy #3682

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
213ef40
Adding versioning policy
leandrodamascena Jan 30, 2024
50d1ce8
docs: update wording to reflect Powertools for AWS Lambda
heitorlessa Jan 30, 2024
9b8d6c5
docs: adjust timelines, refer to tight coupling w/ Lambda runtime policy
heitorlessa Jan 30, 2024
68f153b
docs: fix grammar
heitorlessa Jan 30, 2024
891329d
Adressing Andrea's feedback
leandrodamascena Jan 30, 2024
1ebce9b
Merge branch 'develop' into docs-versioning-policy
leandrodamascena Jan 31, 2024
c0fecf3
docs: GA minimal commitment adjustment to allow each language to set …
heitorlessa Jan 31, 2024
46ea32e
docs: final line editing
heitorlessa Jan 31, 2024
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
6 changes: 3 additions & 3 deletions docs/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The lifecycle for major Powertools for AWS Lambda versions consists of 5 phases,
* **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_.
* **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 12 months_, unless otherwise specified.
* **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"
Expand All @@ -41,7 +41,7 @@ The following terms are used to classify underlying third party dependencies:
* **Language Runtime**: Examples include Python 3.12, NodeJS 20, Java 17, .NET Core, etc.
* **Third party Library**: Examples include Pydantic, AWS X-Ray SDK, AWS Encryption SDK, MiddyJS, etc.

Our policy is to continue supporting SDK dependencies for at least 6 months after the community or vendor ends support for the dependency. This policy, however, could vary depending on the specific dependency.
Powertools for AWS Lambda follows [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 deprecated Language Runtime without increasing the major SDK version.

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

Expand All @@ -51,7 +51,7 @@ 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 SDK documentation.
* 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 [version support matrix](#version-support-matrix)

Expand Down