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

Prepare version v5.0.0 #1336

Merged
merged 4 commits into from
Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from 2 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
33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,39 @@ All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## Release 5.0.0 (2020-09-22)

[Changes since v4.0.0](https://github.com/realm/realm-studio/compare/v4.0.0...v5.0.0)

### Breaking Changes

- Added support for reading / writing Realm files using Realm file format v11 (used by realm-js v6.1.1, realm-java v7.0.4, realm-cocoa v5.4.0 and realm-dotnet v5.0.1). When opening a file which is using an older format, you will get prompted to upgrade (and optionally backup) the Realm file. NOTE: Once the file has been upgraded, there is no way to downgrade it again and it can only be used by the SDKs that support Realm file format v11. ([#1331](https://github.com/realm/realm-studio/pull/1331))
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we remove the patch version? Or actually just mention the version where the new fileformat was introduced?

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add instructions (link?) that describes how to keep the old version of Studio in parallel with the new?
"If you have a need to keep working on both pre v11 and v11 file formats, you can install this new version along an existing version by ..."

Copy link
Member

@kraenhansen kraenhansen Sep 22, 2020

Choose a reason for hiding this comment

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

Should we remove the patch version?

No, I don't think so, since those are the exact versions the new file format got introduced to the respective SDKs. The major versions introduced the v10 file format.

Should we add instructions (link?) that describes how to keep the old version of Studio in parallel with the new?

We don't have that page written up yet. I suggest we patch the changelog (or even better the readme.md) once we have that page ready.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, that's perfect then!


### Enhancements

- None

### Fixed

- None

### Compatibility

Use this version of Realm Studio to read and write Realm database files, using the same file format as:

| SDK | Version |
| ---------------- | ---------- |
| Realm JavaScript | 6.1.1 - ? |
| Realm Java | v7.0.4 - ? |
| Realm Cocoa | v5.4.0 - ? |
| Realm .NET | v5.0.1 - ? |

### Internals

- Upgraded Realm to v6.1.2. ([#1331](https://github.com/realm/realm-studio/pull/1331))
- Upgraded Electron to v9.3.1 and Spectron to v11.1.0 ([#1332](https://github.com/realm/realm-studio/pull/1332))


## Release 4.0.0 (2020-09-22)

[Changes since v3.10.0](https://github.com/realm/realm-studio/compare/v3.11.0...v4.0.0)
Expand Down
18 changes: 1 addition & 17 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
[Changes since {PREVIOUS_VERSION}](https://github.com/realm/realm-studio/compare/{PREVIOUS_VERSION}...{CURRENT_VERSION})

### Breaking Changes

- Added support for reading / writing Realm files using Realm file format v11 (used by realm-js v6.1.1, realm-java v7.0.4, realm-cocoa v5.4.0 and realm-dotnet v5.0.1). When opening a file which is using an older format, you will get prompted to upgrade (and optionally backup) the Realm file. NOTE: Once the file has been upgraded, there is no way to downgrade it again and it can only be used by the SDKs that support Realm file format v11. ([#1331](https://github.com/realm/realm-studio/pull/1331))

### Enhancements

- None
Expand All @@ -12,18 +8,6 @@

- None

### Compatibility

Use this version of Realm Studio to read and write Realm database files, using the same file format as:

| SDK | Version |
| ---------------- | ---------- |
| Realm JavaScript | 6.1.1 - ? |
| Realm Java | v7.0.4 - ? |
| Realm Cocoa | v5.4.0 - ? |
| Realm .NET | v5.0.1 - ? |

### Internals

- Upgraded Realm to v6.1.2. ([#1331](https://github.com/realm/realm-studio/pull/1331))
- Upgraded Electron to v9.3.1 and Spectron to v11.1.0 ([#1332](https://github.com/realm/realm-studio/pull/1332))
- None
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "realm-studio",
"productName": "Realm Studio",
"version": "3.11.0",
"version": "4.0.0",
"description": "A tool for everything Realm!",
"author": {
"name": "Realm Inc.",
Expand Down