Browse Source

add end-of-support policy

Charles Kerr 7 years ago
parent
commit
d76b0223d9
1 changed files with 27 additions and 2 deletions
  1. 27 2
      docs/tutorial/support.md

+ 27 - 2
docs/tutorial/supported-platforms.md → docs/tutorial/support.md

@@ -1,4 +1,29 @@
-# Supported Platforms
+# Electron Support
+
+## Supported Versions
+
+The Electron maintainers support the latest three release branches.
+For example, if the latest release is 2.0.x, then the 2-0-x series
+is supported, as are the two previous release series 1-7-x and 1-8-x.
+
+When a release branch reaches the end of its support cycle,
+the series will be deprecated in NPM and a final end-of-support release
+will be made. This release will add a console warning to inform that
+an unsupported version of Electron is in use.
+
+These steps are to help app developers learn when a branch they're using
+becomes unsupported, and to avoid being intrusive to end users.
+
+If an application has exceptional circumstances and needs to stay
+on an unsupported series of Electron, developers can silence the
+end-of-support warning by omitting the final release from the app's
+`package.json` `devDependencies`. For example, since the 1-6-x series
+ended with an end-of-support 1.6.18 release, developers could choose
+to stay in the 1-6-x series without warnings with `devDependency  of
+`"electron": 1.6.0 - 1.6.17`.
+
+
+## Supported Platforms
 
 Following platforms are supported by Electron:
 
@@ -30,7 +55,7 @@ distribution includes the libraries that Electron is linked to on the building
 platform, so only Ubuntu 12.04 is guaranteed to work, but following platforms
 are also verified to be able to run the prebuilt binaries of Electron:
 
-* Ubuntu 12.04 and later
+* Ubuntu 12.04 and newer
 * Fedora 21
 * Debian 8