From cd411a5c36808547a4c24b32bd9ad9c5459d8a5e Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 23 Aug 2017 14:11:20 -0700 Subject: [PATCH] document how we define stable --- docs/tutorial/electron-versioning.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/tutorial/electron-versioning.md b/docs/tutorial/electron-versioning.md index bf8f68dfb863..70b97f878603 100644 --- a/docs/tutorial/electron-versioning.md +++ b/docs/tutorial/electron-versioning.md @@ -47,6 +47,27 @@ The `latest` and `next` [npm dist tags] are also used: - `npm install electron@latest` will install the latest _stable_ version. - `npm install electron@next` will install the very latest _unstable_ version. +## Stable Releases + +In general, a version is considered stable after its most recent +[prerelease](#prereleases) has been out for two weeks and any significant bugs +reported against it have been fixed. Note that versions are not promoted on a +set schedule, and timing can fluctuate per release. + +We recommend using the following command to ensure you're using a stable +version of Electron: + +```sh +npm install electron --save-exact --save-dev +``` + +If you have an existing Electron app and want to update it to use the latest +stable version of `electron`, use the `@latest` identifier: + +```sh +npm install electron@latest --save-exact --save-dev +``` + [Semantic Versioning]: http://semver.org [pre-release identifier]: http://semver.org/#spec-item-9 [npm dist tags]: https://docs.npmjs.com/cli/dist-tag