From 83bb0e274d6089e298ba1dc71814857322886de3 Mon Sep 17 00:00:00 2001 From: Hui Zhao Date: Fri, 2 May 2025 10:57:30 -0700 Subject: [PATCH 1/3] chore: add Amplify JS LTS documentation --- src/directory/directory.mjs | 3 + .../reference/library-releases/index.mdx | 56 +++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 src/pages/[platform]/reference/library-releases/index.mdx diff --git a/src/directory/directory.mjs b/src/directory/directory.mjs index ef999a6102e..a8041c4ec17 100644 --- a/src/directory/directory.mjs +++ b/src/directory/directory.mjs @@ -1009,6 +1009,9 @@ export const directory = { { path: 'src/pages/[platform]/reference/index.mdx', children: [ + { + path: 'src/pages/[platform]/reference/library-releases/index.mdx' + }, { path: 'src/pages/[platform]/reference/project-structure/index.mdx' }, diff --git a/src/pages/[platform]/reference/library-releases/index.mdx b/src/pages/[platform]/reference/library-releases/index.mdx new file mode 100644 index 00000000000..ca2969dc121 --- /dev/null +++ b/src/pages/[platform]/reference/library-releases/index.mdx @@ -0,0 +1,56 @@ +import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; + +export const meta = { + title: 'Amplify library releases', + description: 'Reference for Amplify library releases', + platforms: [ + 'angular', + 'javascript', + 'nextjs', + 'react', + 'react-native', + 'vue' + ] +}; + +export async function getStaticPaths() { + return getCustomStaticPath(meta.platforms); +} + +export async function getStaticProps() { + return { + props: { + meta, + } + }; +} + + + +## Amplify JS versioning + +Amplify JS follows [semantic versioning](https://semver.org/) for releases. You may learn about the potential impact when you update to a newer version via a the version numbers. + +- **Major version release:** contains significant new features, necessary breaking changes for supporting new features or architecture changes, supported peer dependencies version range changes. When updating to a new major version, you may need to follow Amplify JS published migration guide to adapt new changes, and learn about new APIs. +- **Minor version release:** contains new small and additive features. A minor version is backwards-compatible, you are not required to make any changes in your projects to update to a new minor version. +- **Patch version release:** contains bug fixes. + +## Version support + +### Support policy + +- **Active:** receives regular bug fixes, new additive features, security patches +- **LTS:** receives regression fixes, impactful bug fixes, security patches +- **Deprecated:** end of life + +| Versions | Release Date | Status | LTS Ends | +| ------------- | ------------ | ---------- | --------------- | +| ^6.0.0 | 2023-10-27 | Active | To be announced | +| ^5.0.0 | 2022-11-08 | LTS | To be announced | +| ^4.0.0 | 2021-05-11 | LTS | 2025-11-15 | +| ^3.0.0 | 2020-03-31 | LTS | 2025-08-15 | +| ^2.0.0 | 2019-11-14 | LTS | 2025-08-15 | +| ^1.0.0 | 2018-07-13 | LTS | 2025-08-15 | +| 0.x (Preview) | 2017-11-17 | Deprecated | | + + From f8684b8a4b283a1247ec0ff4cbb1b493bb0e2ef7 Mon Sep 17 00:00:00 2001 From: Hui Zhao Date: Fri, 2 May 2025 12:14:06 -0700 Subject: [PATCH 2/3] chore: tweaks --- .../reference/library-releases/index.mdx | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/pages/[platform]/reference/library-releases/index.mdx b/src/pages/[platform]/reference/library-releases/index.mdx index ca2969dc121..2668403435b 100644 --- a/src/pages/[platform]/reference/library-releases/index.mdx +++ b/src/pages/[platform]/reference/library-releases/index.mdx @@ -1,8 +1,8 @@ import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; export const meta = { - title: 'Amplify library releases', - description: 'Reference for Amplify library releases', + title: 'Amplify libraries version & support', + description: 'Reference for Amplify libraries version & support', platforms: [ 'angular', 'javascript', @@ -29,19 +29,20 @@ export async function getStaticProps() { ## Amplify JS versioning -Amplify JS follows [semantic versioning](https://semver.org/) for releases. You may learn about the potential impact when you update to a newer version via a the version numbers. +Amplify JS follows [semantic versioning](https://semver.org/) for releases. This specification for version numbers imparts meaning to the underlying code changes between versions and the potential impact when you perform an update. -- **Major version release:** contains significant new features, necessary breaking changes for supporting new features or architecture changes, supported peer dependencies version range changes. When updating to a new major version, you may need to follow Amplify JS published migration guide to adapt new changes, and learn about new APIs. -- **Minor version release:** contains new small and additive features. A minor version is backwards-compatible, you are not required to make any changes in your projects to update to a new minor version. +- **Major version release:** contains significant new features, necessary breaking changes to support new features, or changes to supported peer dependencies versions. Updating to the latest major version is almost always recommended, however you may need to follow Amplify JS migration guides to integrate new changes into existing projects and discover new APIs. +- **Minor version release:** contains new small, additive features. A minor version is backwards-compatible; you are not required to make any changes in your projects to update to a newer minor version. - **Patch version release:** contains bug fixes. ## Version support ### Support policy -- **Active:** receives regular bug fixes, new additive features, security patches -- **LTS:** receives regression fixes, impactful bug fixes, security patches -- **Deprecated:** end of life +- **Active:** receives regular bug fixes, new additive features, security patches. +- **LTS:** receives regression fixes, impactful bug fixes, security patches. +- **Deprecated:** end of life; no longer officially supported. + | Versions | Release Date | Status | LTS Ends | | ------------- | ------------ | ---------- | --------------- | @@ -53,4 +54,7 @@ Amplify JS follows [semantic versioning](https://semver.org/) for releases. You | ^1.0.0 | 2018-07-13 | LTS | 2025-08-15 | | 0.x (Preview) | 2017-11-17 | Deprecated | | +### Migration guides + +- [Migration from Amplify JS v5 to Amplify JS v6](https://hui-chore-js-lts.d1ywzrxfkb9wgg.amplifyapp.com/gen1/react/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/) From 2b27e61fc127a0e0803ef8ba64ff231fbee6dcec Mon Sep 17 00:00:00 2001 From: Hui Zhao Date: Thu, 8 May 2025 10:51:17 -0700 Subject: [PATCH 3/3] chore: resolve comments --- src/pages/[platform]/reference/library-releases/index.mdx | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/pages/[platform]/reference/library-releases/index.mdx b/src/pages/[platform]/reference/library-releases/index.mdx index 2668403435b..3e2cc1273e1 100644 --- a/src/pages/[platform]/reference/library-releases/index.mdx +++ b/src/pages/[platform]/reference/library-releases/index.mdx @@ -25,9 +25,7 @@ export async function getStaticProps() { }; } - - -## Amplify JS versioning +## The JavaScript library versioning Amplify JS follows [semantic versioning](https://semver.org/) for releases. This specification for version numbers imparts meaning to the underlying code changes between versions and the potential impact when you perform an update. @@ -56,5 +54,4 @@ Amplify JS follows [semantic versioning](https://semver.org/) for releases. This ### Migration guides -- [Migration from Amplify JS v5 to Amplify JS v6](https://hui-chore-js-lts.d1ywzrxfkb9wgg.amplifyapp.com/gen1/react/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/) - +- [Migration from Amplify JS v5 to Amplify JS v6](/gen1/[platform]/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/)