realm / realm-studio

Realm Studio
https://realm.io/products/realm-studio/
Apache License 2.0
296 stars 38 forks source link

Hoist Realm JS release notes into Realm Studios release notes #829

Open kraenhansen opened 6 years ago

kraenhansen commented 6 years ago

To increase transparency around compatibility the Realm Studio releases should hoist the Realm JS release notes / changelog into Realm Studios release notes.

This could probably be achieved when preparing a build by:

  1. Determining tag of the most recent release of Realm Studio (using git describe --abbrev=0 --tags)
  2. Checking out at the latest release tag and reading the Realm JS version from the package lock.
  3. Checking out the latest version of master, npm installing to get the current version of Realm JS.
  4. Parse the node_modules/realm/CHANGELOG.md to get the changes between the two versions of Realm JS.
  5. Append this to the changelog in a > quote.
bmunkholm commented 6 years ago

I'm not sure that would be useful. The release note for Studio is for the end users of Studio, so it should only reflect the changes that affects them?

kraenhansen commented 6 years ago

Perhaps they could be added to the release notes and then edited or removed to be more user facing?