From 22e78aba9ec96deb1b50b48e21aa0829340678f0 Mon Sep 17 00:00:00 2001 From: Benjamin Farley Date: Wed, 23 Jun 2021 14:22:59 -0600 Subject: [PATCH 1/2] chore: Add support policy --- README.rst | 4 ++++ SUPPORT_POLICY.rst | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 SUPPORT_POLICY.rst diff --git a/README.rst b/README.rst index 0adc6495d..4584f260e 100644 --- a/README.rst +++ b/README.rst @@ -26,6 +26,8 @@ Find us on `GitHub`_. `Security issue notifications`_ +See `Support Policy`_ for details on the current support status of all major versions of this library. + *************** Getting Started *************** @@ -49,6 +51,7 @@ Installation $ pip install aws-encryption-sdk + Concepts ======== There are four main concepts that you need to understand to use this library: @@ -318,3 +321,4 @@ to your use-case in order to obtain peak performance. .. _final message: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html .. _encryption context: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context .. _Security issue notifications: ./CONTRIBUTING.md#security-issue-notifications +.. _Support Policy: ./SUPPORT_POLICY.rst diff --git a/SUPPORT_POLICY.rst b/SUPPORT_POLICY.rst new file mode 100644 index 000000000..118ed03a5 --- /dev/null +++ b/SUPPORT_POLICY.rst @@ -0,0 +1,33 @@ +Overview +======== +This page describes the support policy for the AWS Encryption SDK. We regularly provide the AWS Encryption SDK with updates that may contain support for new or updated APIs, new features, enhancements, bug fixes, security patches, or documentation updates. Updates may also address changes with dependencies, language runtimes, and operating systems. + +We recommend users to stay up-to-date with Encryption SDK releases to keep up with the latest features, security updates, and underlying dependencies. Continued use of an unsupported SDK version is not recommended and is done at the user’s discretion + + +Major Version Lifecycle +======================== +The AWS Encryption SDK follows the same major version lifecycle as the AWS SDK. For details on this lifecycle, see `AWS SDKs and Tools Maintenance Policy`_. + +Version Support Matrix +====================== +This table describes the current support status of each major version of the AWS Encryption SDK for Python. It also shows the next status each major version will transition to, and the date at which that transition will happen. + +.. list-table:: + :widths: 30 50 50 50 + :header-rows: 1 + + * - Major version + - Current status + - Next status + - Next status date + * - 1.x + - Maintenance + - End of Support + - 2022-06-30 + * - 2.x + - General Availability + - Maintenance + - 2021-06-30 + +.. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle From b89b5bf7538465b4626123d2210a614023443960 Mon Sep 17 00:00:00 2001 From: Benjamin Farley Date: Thu, 1 Jul 2021 09:14:28 -0600 Subject: [PATCH 2/2] Update dates, and add upcoming 3.x --- SUPPORT_POLICY.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/SUPPORT_POLICY.rst b/SUPPORT_POLICY.rst index 118ed03a5..c787cf1a8 100644 --- a/SUPPORT_POLICY.rst +++ b/SUPPORT_POLICY.rst @@ -28,6 +28,10 @@ This table describes the current support status of each major version of the AWS * - 2.x - General Availability - Maintenance - - 2021-06-30 + - 2021-07-01 + * - 3.x + - + - General Availability + - 2021-07-01 .. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle