chore: add Amplify JS LTS documentation #8348
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,60 @@ | ||||||
| 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, | ||||||
| } | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| <InlineFilter filters={['javascript', "angular", "nextjs", "react", "vue"]}> | ||||||
|
|
||||||
| ## Amplify JS 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 | | ||||||
|
There was a problem hiding this comment. is there a way to highlight LTS with end date in different color or something? There was a problem hiding this comment. 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](https://hui-chore-js-lts.d1ywzrxfkb9wgg.amplifyapp.com/gen1/react/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| </InlineFilter> | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should be safe to remove this filter in favor of using the platform filter in the page meta
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed.