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.

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

Split changelog and compability matrix. Update readme and support. #5748

Merged
merged 4 commits into from
Apr 22, 2023
Merged
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,108 changes: 3,108 additions & 0 deletions CHANGELOG.legacy.md

Large diffs are not rendered by default.

5,265 changes: 3 additions & 5,262 deletions CHANGELOG.md

Large diffs are not rendered by default.

1,563 changes: 1,563 additions & 0 deletions CHANGELOG.v10.md

Large diffs are not rendered by default.

684 changes: 684 additions & 0 deletions CHANGELOG.v11.md

Large diffs are not rendered by default.

25 changes: 2 additions & 23 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,5 @@

| Realm JavaScript | React Native | Expo | Hermes | npm | node |
|------------------------|--------------------|----------|--------|--------|--------|
| 11.5.1 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 |
| 11.5.0 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 |
| 11.4.0 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 |
| 11.3.1 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.2.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.1.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.0.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.2 | >= 0.70.0 | N/A | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.1 | >= 0.69.0 < 0.70.0 | 46 | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.0 | >= 0.66.0 < 0.69.0 | 45 | ✅ | >= 7 | >= 13 |
| 10.24.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.23.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.22.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.21.1 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.20.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.5 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.4 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.3 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.2 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.1 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
| 10.18.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
| 10.17.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
| 12.0.0-alpha.2 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
kneth marked this conversation as resolved.
Show resolved Hide resolved
| 12.0.0-alpha.1 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
18 changes: 18 additions & 0 deletions COMPATIBILITY.v10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# React Native and Expo compatibility


| Realm JavaScript | React Native | Expo | Hermes | npm | node |
|------------------------|--------------------|----------|--------|--------|--------|
| 10.24.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.23.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.22.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.21.1 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.20.0 | >= 0.64.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.5 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.4 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.3 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.2 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.1 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 13 |
| 10.19.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
| 10.18.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
| 10.17.0 | >= 0.60.0 | 44 | ❌ | >= 7 | >= 10 |
18 changes: 18 additions & 0 deletions COMPATIBILITY.v11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# React Native and Expo compatibility

| Realm JavaScript | React Native | Expo | Hermes | npm | node |
|------------------------|--------------------|----------|--------|--------|--------|
| 11.8.0 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
| 11.7.0 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
| 11.6.0 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
| 11.5.2 | >= 0.71.4 | 48 | ✅ | >= 7 | >= 13 |
| 11.5.1 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 (excluding 19) |
| 11.5.0 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 (excluding 19) |
| 11.4.0 | = 0.71.0 | N/A | ✅ | >= 7 | >= 13 (excluding 19) |
| 11.3.1 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 (but not 19) |
| 11.2.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 (but not 19) |
| 11.1.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.0.0 | >= 0.70.0 | 47 | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.2 | >= 0.70.0 | N/A | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.1 | >= 0.69.0 < 0.70.0 | 46 | ✅ | >= 7 | >= 13 |
| 11.0.0-rc.0 | >= 0.66.0 < 0.69.0 | 45 | ✅ | >= 7 | >= 13 |
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ See [CONTRIBUTING.md](https://github.com/realm/realm-js/blob/main/CONTRIBUTING.m
* [Flipper](https://fbflipper.com/) has many similar features in relation to the Chrome Debugger.
* [Safari](https://reactnative.dev/docs/debugging#safari-developer-tools) also has a similar feature set, but requires [some setup](https://blog.nparashuram.com/2019/10/debugging-react-native-ios-apps-with.html) and only supports debugging in iOS.
* **NOTE:** For the above methods, it is not neccessary to enable `Debug with Chrome` in the Debug Menu.
* Version 10.21.0 accidently [dropped support other Linux versions](https://github.com/realm/realm-js/issues/5006) e.g., RHEL 7.

## Building Realm JS

Expand Down
8 changes: 4 additions & 4 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ The Realm team is here to help you with your Realm-related issues!

## Documentation

Before asking questions, please familiarize yourself with our [Javascript](https://realm.io/docs/javascript/latest/) documentation. We also have a number of [Tech Notes](https://realm.io/docs/tech-notes/) which cover various topics that may be of interest.
Before asking questions, please familiarize yourself with our [Node.js](https://www.mongodb.com/docs/realm/sdk/node/) and [React Native](https://www.mongodb.com/docs/realm/sdk/react-native/) documentation.

## Stack Overflow
## MongoDB Developer Community

If you have questions about configuring or using Realm you can ask them on Stack Overflow. We continually monitor the [`realm` tag](https://stackoverflow.com/tags/realm). Please also tag your question with `javascript` or other tags as appropriate.
If you have questions about configuring or using Realm you can ask the [MongoDB Developer Community](https://www.mongodb.com/community/forums/).

When asking questions on Stack Overflow, please keep in mind Stack Overflow's [question guidelines](https://stackoverflow.com/help/how-to-ask), and please use their search functionality to see if your question has been asked before.
When asking questions on the MongoDB Developer Community forums, please keep in mind the [guidelines](https://www.mongodb.com/community/forums/guidelines), and please use the search functionality to see if your question has been asked before.

## GitHub Issues

Expand Down
4 changes: 2 additions & 2 deletions scripts/changelog-header.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ CHANGELOG=$(cat <<EOF
* None

### Compatibility
* React Native >= v0.71.0
* Realm Studio v13.0.0.
* React Native >= v0.71.4
* Realm Studio v14.0.0.
* File format: generates Realms with format v23 (reads and upgrades file format v5 or later for non-synced Realm, upgrades file format v10 or later for synced Realms).

### Internal
Expand Down