Electron 版本管理

详细查看我们的版本控制策略和实现。

从版本 2.0.0, Electron 遵循 semver 。以下命令将安装 Electron 最新稳定的版本:

  1. npm install --save-dev electron

现有项目更新到最新的稳定版本:

  1. npm install --save-dev electron@latest

版本1.x

小于 2.0的Electron版本编号并不遵循 semver 规范: major版本对应最终用户API的变更, minor版本更新对应Chromium的主版本更新, patch 版本更新会带来新功能和bug修复. 虽然方便开发人员合并功能，但却为面向客户端应用程序的开发人员带来了麻烦。 像Slack，Stride，Teams，Skype，VS Code，Atom和Desktop等主要应用程序的QA测试周期可能很长，稳定性是一个非常理想的结果。 尝试吸收错误修复时，采用新功能的风险很高。

以下是 1.x 策略的一个例子：

Electron 版本管理 - 图1

使用 1.8.1开发的应用程序无法吸收 1.8.2 的功能，或者通过反向移植修复和维护新的发行版，无法采用 1.8.3错误修复。

版本 2.0 和之后版本

下面列出的 1.x 策略有几个主要的变化。 每个更改都是为了满足开发人员/维护人员和应用程序开发人员的需求和优先级。

  • 严格使用 semver
  • 引入符合 semver 的 -beta 标签
  • 引入常规提交消息
  • 明确定义的稳定分支
  • master分支没有版本信息，只有稳定分支会包含版本信息。
    我们将详细介绍 git 分支是如何工作的，npm 标记是如何工作的，开发人员应该看到什么，以及如何能够支持更改。

semver

从 2.0 开始，Electron 将遵循 semver。

下面是一个表格，明确地将变化的类型映射到它们对应的 semver 类别 (例如Major，Minor，Patch)。

Major 版本增量Minor 版本增量Patch 版本增量
Electron 突破性 API 变更Electron 无突破性 API 变更Electron bug 修复
Node.js 重大版本更新Node.js 次要版本更新Node.js patch 版本更新
Chromium 版本更新修复相关的 chromium 补丁

请注意，大多数 Chromium 更新将被视为突破性更新。 可以从新版被向后移植的修复可能会被挑选出来作为补丁修复现有版本。

稳定分支

稳定分支是与主控并行运行的分支，仅接受与安全性或稳定性有关的最优提交。 这些分支从不合并回主分支。

Electron 版本管理 - 图2

稳定分支始终是 major 或 minor 版本, 并按照以下模板命名$MAJOR-$MINOR-x.例如 2-0-x.

我们允许同时存在多个稳定分支，并且打算在任何时候至少支持两个并行支持安全修复。 Electron 版本管理 - 图3

GitHub不支持旧线路，但是其他分组可以自行获取所有权和返回稳定性和安全修复。 我们不鼓励这样做，但是认识到它使得许多应用程序开发人员的生活更轻松。

测试版和 Bug 修复

开发人员想知道哪个版本可以 安全 使用。 即使是简单的功能也会使应用程序变得复杂。 同时，锁定到一个固定的版本是很危险的，因为你忽略了自你的版本以来可能出现的安全补丁和错误修复。 我们的目标是在 package.json 中允许以下标准的 semver 范围:

  • 使用 ~ 2.0. 0 只接受您的 2.0.0 版本的稳定性或安全性相关的修复程序。
  • 使用 ^ 2.0. 0 可允许不破坏性的 合理稳定 功能以及安全性和 bug 修复。
    第二点重要的是使用 ^ 的应用程序仍然能够期望合理的稳定性水平。 为了达到这个目的，semver允许一个 pre-release 标识 来表示一个特定的版本还不 安全 或 稳定.

无论你选择什么，你将定期不得不在 package.json 中打破版本，因为突破性变更是 Chromium 的一个常态。

过程如下:

  • All new major and minor releases lines begin with a beta series indicated by semver prerelease tags of beta.N, e.g. 2.0.0-beta.1. After the first beta, subsequent beta releases must meet all of the following conditions:

    • The change is backwards API-compatible (deprecations are allowed)
    • The risk to meeting our stability timeline must be low.
  • If allowed changes need to be made once a release is beta, they are applied and the prerelease tag is incremented, e.g. 2.0.0-beta.2.
  • If a particular beta release is generally regarded as stable, it will be re-released as a stable build, changing only the version information. e.g. 2.0.0. After the first stable, all changes must be backwards-compatible bug or security fixes.

  • If future bug fixes or security patches need to be made once a release is stable, they are applied and the patch version is incremented e.g. 2.0.1.
    特别地，上述步骤意味着：

  • Admitting non-breaking-API changes early in the beta cycle is okay, even if those changes have the potential to cause moderate side-affects

  • Admitting feature-flagged changes, that do not otherwise alter existing code paths, at most points in the beta cycle is okay. Users can explicitly enable those flags in their apps.
  • Admitting features of any sort very late in the beta cycle is
    对于每个主要和次要的颠覆，你都应该像以下示例一样进行操作：
  1. 2.0.0-beta.1
  2. 2.0.0-beta.2
  3. 2.0.0-beta.3
  4. 2.0.0
  5. 2.0.1
  6. 2.0.2

图片中的生命周期示例:

  • 将创建一个新的发布分支, 其中包括最新的一组功能。它被发布为 2.0. 0-beta 1。 Electron 版本管理 - 图4
  • Bug 修复进入主分支，即反向移植（backport）到发布分支中。补丁程序运行，新的测试版发布为 2.0. 0-beta 2。 Electron 版本管理 - 图5
  • 测试版被认为是 一般稳定 的, 它在 2.0.0 下作为非 beta 版本再次被发布。 Electron 版本管理 - 图6
  • 之后，释放一个零日漏洞，同时将修复应用于主分支（用以检测修复效果）。 我们将补丁程序反向移植到 2-0-x版本序列中，发布2.0.1。 Electron 版本管理 - 图7
    几个不同的 semver 范围将如何接收新版本的示例:

Electron 版本管理 - 图8

缺失的特性: alpha版本

我们的战略有几次权衡，我们现在认为这是适当的。 最重要的是, 新的主分支特性可能需要一段时间才能作为稳定版发布。 如果你想立即尝试一个新的特性, 你必须自己编译Electron 。

作为未来的考虑, 我们可以介绍以下一种或两种情况:

  • 具有松散稳定性限制的 alpha 释放版; 例如, 当稳定通道在 alpha 中时, 允许接纳新特性

功能标志

功能标志是 Chromium 的一种常见的做法, 在网络开发生态系统中得到了很好的确立。 在 Electron 环境中, 功能标志或 软分支 必须具有以下属性:

  • 是在运行时或生成时启用/禁用的。我们不支持请求作用域功能标志的概念
  • 它完全细分新的和旧的代码路径; 重构旧代码以允许新功能 违反 功能标志内容
  • feature flags are eventually removed after the feature is released

提交语义

我们力求在更新和发布过程的各个层面提高清晰度。 从 2.0.0 开始, 我们将要求遵循 常规提交 规范的拉请求, 可以概括如下:

  • 会导致 semver major 版本改变的提交必须以BREAKING CHANGE:开头。

  • 会导致 semver minor 版本改变的提交必须以 feat: 开头。

  • 会导致 semver patch 版本改变的提交必须以 fix: 开头。

  • 我们允许合并提交，只要合并提交的消息符合上述消息格式。

  • 只要pull request里包含有意义的总结性的版本语义消息，即使它其中的某些提交消息不包含版本语义前缀也是可以接受的

打了版本的 主分支

  • The master branch will always contain the next major version X.0.0-nightly.DATE in its package.json
  • Release 分支永远不会合并回 master 分支
  • 发布分支 在 其package.json 中包含正确的版本
  • 只要一个 release 分支被切出来用于发布 major 版本, 主分支就必须跳到下一个 major 版本. 也就是说master 总会被视作下一个理论上要发布的版本的分支。