Skip to content

chore: add Amplify JS LTS documentation #8348

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 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/directory/directory.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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'
},
Expand Down
57 changes: 57 additions & 0 deletions src/pages/[platform]/reference/library-releases/index.mdx
Original file line number Diff line number Diff line change
@@ -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 |
Copy link
Contributor

@ashika112 ashika112 May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a way to highlight LTS with end date in different color or something?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this table contains equally important information, there shouldn't be a need of highlighting certain part of information. (I couldn't find a way to change text color in a cell of a table either from MDX's doc)

| 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/)