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..3e2cc1273e1 --- /dev/null +++ b/src/pages/[platform]/reference/library-releases/index.mdx @@ -0,0 +1,57 @@ +import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; + +export const meta = { + title: 'Amplify libraries version & support', + description: 'Reference for Amplify libraries version & support', + platforms: [ + 'angular', + 'javascript', + 'nextjs', + 'react', + 'react-native', + 'vue' + ] +}; + +export async function getStaticPaths() { + return getCustomStaticPath(meta.platforms); +} + +export async function getStaticProps() { + return { + props: { + meta, + } + }; +} + +## 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. + +- **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; no longer officially supported. + + +| 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 | | + +### Migration guides + +- [Migration from Amplify JS v5 to Amplify JS v6](/gen1/[platform]/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/)