mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

tweak versioning doc

Browse source
This commit is contained in:
Zeke Sikelianos 2017-08-23 14:14:59 -07:00
parent cd411a5c36
commit d51a8accee
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/tutorial/electron-versioning.md
View file

@ -4,17 +4,18 @@ If you've been using Node and npm for a while, you are probably aware of [Semant
Due to its dependency on Node and Chromium, it is not possible for the Electron Due to its dependency on Node and Chromium, it is not possible for the Electron
project to adhere to a strict [Semantic Versioning] policy. **You should project to adhere to a strict [Semantic Versioning] policy. **You should
therefore always reference a specific version of Electron.** therefore always reference a specific version of Electron** in your
`package.json` file.
Electron version numbers are bumped using the following rules: Electron version numbers are bumped using the following rules:
* **Major** is for breaking changes in Electron's API. If you upgrade from `0.37.0` * **Major** is for breaking changes in Electron's API. If you upgrade from `0.37.0`
to `1.0.0`, you will have to make changes to your app. to `1.0.0`, you will have to make changes to your app.
* **Minor** is for major Chrome and minor Node upgrades, or significant Electron * **Minor** is for major Chrome and minor Node upgrades, or significant Electron
changes. If you upgrade from `1.5.0` to `1.6.0`, your app is supposed to changes. If you upgrade from `1.5.0` to `1.6.0`, your app should
still work, but you might have to work around small changes. still work, but you might have to work around small changes.
* **Patch** is for new features and bug fixes. If you upgrade from `1.6.2` to * **Patch** is for new features and bug fixes. If you upgrade from `1.6.2` to
`1.6.3`, your app will continue to work as-is. `1.6.3`, your app should continue to work as-is.
We recommend that you set a fixed version when installing Electron from npm: We recommend that you set a fixed version when installing Electron from npm:
@ -22,9 +23,10 @@ We recommend that you set a fixed version when installing Electron from npm:
npm install electron --save-exact --save-dev npm install electron --save-exact --save-dev
``` ```
The `--save-exact` flag will add `electron` to your `package.json` file without The `--save-exact` flag will add `electron` to your `package.json` file _without
using a `^` or `~`, e.g. `1.6.2` instead of `^1.6.2`. This practice ensures that a range identifier_ like `^` or `~`, e.g. `1.6.2` instead of `^1.6.2`. This
all upgrades of Electron are a manual operation made by you, the developer. practice ensures that all upgrades of Electron are a manual operation made by
you, the developer.
Alternatively, you can use the `~` prefix in your SemVer range, like `~1.6.2`. Alternatively, you can use the `~` prefix in your SemVer range, like `~1.6.2`.
This will lock your major and minor version, but allow new patch versions to This will lock your major and minor version, but allow new patch versions to