From 7e09b1664ad16c1d45a48efc6e06d585360395ef Mon Sep 17 00:00:00 2001 From: Felix Rieseberg Date: Tue, 17 May 2016 20:20:25 +0200 Subject: [PATCH] :memo: Add Information about Versioning --- docs/README.md | 1 + docs/tutorial/electron-versioning.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/tutorial/electron-versioning.md diff --git a/docs/README.md b/docs/README.md index 9974993..1faf3d3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,6 +18,7 @@ an issue: * [Supported Platforms](tutorial/supported-platforms.md) * [Security](tutorial/security.md) +* [Electron Versioning](tutorial/electron-versioning.md) * [Application Distribution](tutorial/application-distribution.md) * [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md) * [Application Packaging](tutorial/application-packaging.md) diff --git a/docs/tutorial/electron-versioning.md b/docs/tutorial/electron-versioning.md new file mode 100644 index 0000000..b30fa94 --- /dev/null +++ b/docs/tutorial/electron-versioning.md @@ -0,0 +1,11 @@ +# Electron Versioning + +If you are a seasoned Node developer, you are surely aware of `semver` - and might be used to giving your dependency management systems only rough guidelines rather than fixed version numbers. Due to the hard dependency on Node and Chromium, Electron is in a slightly more difficult position and does not follow semver. You should therefor always reference a specific version of Electron. + +Version numbers are bumped using the following rules: + + * Major: For breaking changes in Electron's API - if you upgrade from `0.37.0` to `1.0.0`, you will have to update your app. + * Minor: For major Chrome and minor Node upgrades; or significant Electron changes - if you upgrade from `1.0.0` to `1.1.0`, your app is supposed to still work, but you might have to work around small changes. + * Patch: For new features and bug fixes - if you upgrade from `1.0.0` to `1.0.1`, your app will continue to work as-is. + +If you are using `electron-prebuilt`, we recommend that you set a fixed version number (`1.1.0` instead of `^1.1.0`) to ensure that all upgrades of Electron are a manual operation made by you, the developer. -- 2.7.4