Kuikly 动态化发布平台使用指引
一、前置条件
1.1 创建项目与产品
在 Shiply 平台创建项目,以及对应的 Android、iOS 平台产品。您也可以按照 如何创建项目和产品 的指引完成该步骤。
创建好产品后,平台会为您分配 appId
和 appKey
,这将作为 SDK 访问服务的认证凭据。
1.2 接入 Kuikly 动态化 SDK
完成 Kuikly 动态化的 SDK 接入工作,并可以成功构建生成各平台动态发布产物。 您也可以按照 接入 Kuikly SDK 的指引完成该步骤。
二、使用指引
2.1 创建模块
点击模块列表右上角「新建模块」按钮进入新建模块页面。
模块名称: 用于区分不同的模块,客户端侧打开页面、检查产物更新时需要传入
描述: 该模块的简要描述信息
标签: 用于页面展示及列表过滤
负责人: 该模块的负责人,只有负责人才有权限编辑当前模块
审核人: 该模块任务发布时的发布审批人,审核人有权通过或驳回发布申请
绑定方式: 模块与下发资源的绑定关系,同时绑定需要下发那些平台
- 新模块请直接选择:新增资源Key,并添加需要动态发布的产品(Android、iOS产品)
2.2 新建发布任务
模块创建好之后,点击「新建任务」按钮进入新建任务页面,创建一个实际的任务用于下发控制。
1. 填写基础信息
任务描述: 本次发布任务的简要描述
模块版本号: 本次发布的模块版本号,仅作为业务自行管理使用
制品可降级: 用户命中该任务后,是否可以加载比该任务制品版本更低的产物(建议不做修改)
目标产品: 本次发布需要面向那些平台的产品进行发布
2. 填写下发条件和关联制品
这里需要根据前面选择的目标产品
,为每个产品配置各自的下发条件和关联制品
下发条件: 用户可以自行配置该任务的下发规则,只有满足条件的用户才能拉取到该任务
关联制品: 本次发布的动态产物制品,可以在页面上进行上传,也可以选择历史上传的包
生成差量包: 需要针对哪些历史发布任务生成差量包
3. 填写放量策略
任务发布支持灰度发布、平滑灰度、立即发布三种模式,用户可以根据需要进行选择。
灰度发布: 分批次的进行发布,放量由少到多,保障发布安全
平滑灰度: 指定总的灰度时长和灰度用户量,平台自动平滑放量
立即发布: 直接全量发布,不限制放量规模
2.3 测试体验
任务创建后默认处在测试体验状态,该阶段只有体验名单中的用户才能拉取到该任务,点击任务可以进入任务详情页面;
开发者可以点击「体验名单」来配置体验账号,对该发布任务进行体验,待验证通过后再继续流程,发起审批操作。
PS: 这里的体验账号填写 SDK 初始化时传入的
userId
字段值
2.4 发布审批
发起审批后,该任务的审核人会收到审批邀请,任务审核人可以检查该任务的相关信息,并对该任务的发布进行审批和驳回。
2.5 启动发布
待审核人审批通过后,任务将自动进入发布状态,此时非体验账号才可以正常的拉取到该任务。
在发布的过程中也可以根据需要随时的对任务进行暂停/恢复、停止等操作。
暂停: 已经拉取到该补丁的用户将继续生效,未拉取到的用户将不会命中该任务
停止: 所有已拉取到该补丁的用户将卸载补丁(等同于撤回补丁)
2.6 发布数据统计
- 生效用户数: 动态产物的下发用户量