Skip to content
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.

Sign up for GitHub

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

docs: add compatibility table to readme #9078

Merged
merged 5 commits into from
Oct 31, 2023
Merged

docs: add compatibility table to readme #9078

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f1f3fc
docs: add compatibility table to readme
runspired Oct 31, 2023
4576ee9
updates
runspired Oct 31, 2023
653b8e9
fix?
runspired Oct 31, 2023
9bb9a81
better with ticks?
runspired Oct 31, 2023
bcb5516
add ticks
runspired Oct 31, 2023
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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Wrangle your application's data management with scalable patterns for developer
- [randomUUID polyfill](#randomuuid-polyfill)
- [Removing inspector support in production](#removing-inspector-support-in-production)
- [Debugging](#debugging)
- [Ember Compatibility](#compatibility)
- [Contributing](#contributing)

# Overview
Expand Down Expand Up @@ -173,6 +174,30 @@ let app = new EmberApp(defaults, {
});
```

## Compatibility

The following table lists EmberData versions alongside information about
ember compatibility.

- **Lockstep**: the latest version of ember-source at the time of release
- **Tested**: the versions of ember-source the project tested this release against
- **Supported**: the versions of ember-source the release officially supports
- **Range**: the peer-dep range the release states for ember-source

the version of
ember-source they were release with (lockstep), as well as the range of versions of ember-source that the
project tested against at the point of release.

| Status | EmberData | Lockstep | Supported | Tested | Range |
| ------ | --------- | -------- | --------- | ------ | ----- |
| Latest | `5.3.0` | `5.3.0` | `4.8` `4.12` `5.*` | `3.28` `4.4` `4.8` `4.12` `5.2` `5.3` | `3.28.12`<br> `>= 4.*` <br> `>= 5.*` |
| LTS | `4.12.4` | `4.12.3` | `4.*` `5.*` | `3.28` `4.4` `4.8` `4.12` `5.0` | `3.28.12`<br> `>= 4.*` <br> `>= 5.*` |
| unsupported<br>(prior LTS) | `4.8.8` | `4.8.6` | `4.*` | `3.28` `4.4` `4.8` | `3.28.12`<br> `>= 4.*` |
| unsupported[^1] | `4.6.4` | `4.6.0` | `3.28` `4.*` | `3.28` `4.4` `4.5` `4.6` | `3.28.12`<br> `>= 4.*` |
| unsupported[^1]<br>(prior LTS) | `4.4.2` | `4.4.6` | `3.28` `4.*` | `3.28` `4.4` | `3.28.12`<br> `>= 4.*` |

[^1]: This version may receive special long-term patches to assist model-fragments users in creating a migration path onto 5.x and off of ModelFragments

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.
Expand Down