HotFix提供可视化的管理后台,进行日常的应用创建、版本添加、补丁上传及发布等操作。

请注意区分百川控制台HotFix管理后台百川控制台内可以对百川账号信息等进行编辑更新,也集合了百川所有产品管理后台的入口,而HotFix管理后台只是其中一个。您可以通过百川控制台"选择应用——>我的产品后台——>阿里百川HotFix"前往HotFix管理后台,也可以直接输入网址 https://hotfix.taobao.com 前往。

Step1 创建应用

HotFix会同步您所有的百川应用,并区分操作系统:Android,iOS。

您也可以在HotFix控制台新增一个百川应用。

您一共可以创建iOS应用10个,Android应用10个。

Step2 获取SDK配置信息

您可以在应用管理页面获取配置SDK所需要的基本信息。包括:

  • AppID:用于AppID是百川上应用的唯一标识
  • RSA密钥: RSA密钥是保存在客户端本地用于解密patch包过程中使用的解密密钥。(推荐使用chrome浏览器下载
  • App Secret:用于URL请求时生成合法验签标识的key。

特别注意:如找不到下图所示页面,请查看本篇文档开头,区分“百川控制台”&“HotFix管理后台”。

Step3 创建版本

您可以在HotFix控制台创建版本。(推荐使用chrome浏览器

  • 版本号:用户自行输入,版本号是为以.分割的多段数字,如1.0.1。版本号必须与用户App内的appVersion相同。如果不相同将导致补丁发布不成功。

Step4 上传补丁文件

在版本详情页面,您可以上传补丁文件。

补丁文件名称规范:

  • Android:文件名必须为 baichuan-hotfix-patch.jar
  • iOS:文件名必须为 *.zip,对于集成1.2.0之前版本的SDK文件名必须为main.js

如何生成Android补丁文件:见文档生成Patch补丁  

如何生成iOS补丁文件:见文档iOS Patch文件生成

也可以浏览补丁状态。

  • 等待中:补丁上传成功,等待操作。
  • 已灰度:补丁正在进行灰度发布。
  • 已发布:补丁已全量发布至所有设备。
  • 已停止:补丁发布行为已暂停。

Step5 发布补丁

HotFix提供了多种发布方式,方便您根据自身业务需要选择性使用。

5.1 本地测试

HotFix提供了调试工具实现本地测试,方便您在正式发布前,在您的手机本地进行测试。
步骤如下:

5.2 灰度发布

HotFix提供灰度发布模式,您可以在控制台设置灰度设备数,系统会将该补丁随机推送至指定数量的设备。其余设备将不会更新该补丁。

  • 设备数:指设备请求更新该补丁的次数,并不等于绝对设备数。例如:1个设备请求了2次更新该补丁,则会消耗掉2的设备数。

灰度后可以根据自身需要停止本次灰度发布,停止后可以选择:

  • 重设灰度发布规则,新的规则中设备数必须大于之前的值。
  • 改为全量发布。
  • 回滚版本(如果存在历史版本)见Step7 发布回滚

5.3 全量发布

HotFix提供全量发布模式,选择全量发布后,将对所有安装了当前应用版本(即之前创建应用时所填写的应用版本号)的设备推送该补丁。

与灰度发布类似,在全量发布会可以根据自身需要停止本次全量发布,停止发布后可以选择:

Step6 停止发布

HotFix提供停止发布功能,用户选择停止发布后,系统将停止该补丁的继续发布。但已加载该补丁的设备会依然保持安装该补丁的状态。

Step7 发布回滚

HotFix提供发布回滚功能,用户选择回滚的目标补丁后,所有该应用版本下的设备都会回滚到目标补丁的版本。

使用回滚功能必需要具备一下几个条件:

  • 当前的版本已停止发布。
  • 该版本之前存在至少一个历史版本。

Step8 继续发布

HotFix提供继续发布功能,用户选择继续发布后,将可以重新设置发布规则。

如果当前版本在停止前处于灰度中,继续发布可以:

  • 重设灰度发布规则,新的规则中设备数必须大于之前的值。
  • 改为全量发布。

如果当前版本在停止如果处于全量发布,继续发布可以:

  • 继续全量发布。

Step9 数据统计

HotFix目前提供两种数据信息。

  • 成功推送设备数:每当有设备发起一次更新请求,且补丁下载成功,则记为一次成功推送。
  • 累计加载设备数:每当有设备成功加载该补丁,则记为一次累计加载。


注:后台数据可能有少许延迟。

Step10 补丁一键清除

HotFix提供补丁一键清除功能。开发者可以对指定应用版本下面的所有补丁进行一键清除操作。

  • 开发者操作一键清除后,app用户在下一次打开应用时,HotFix SDK将清除本地所有补丁,回滚至该应用版本的无补丁状态!请谨慎操作。
  • 开发者操作一键清除后,管理后台的历史补丁将处于“已删除”状态,开发者不可再对补丁执行除浏览外的任何操作。
  • 为保证一键清除功能可用,请保证iOS SDK版本为1.2.1及以上,Android SDK版本为1.4.0及以上。

如在操作过程中遇到任何疑问,欢迎加入钉钉群咨询。

FAQ

关于此文档暂时还没有FAQ
返回
顶部