自动发包工具v0.1

日期 修改人 修改内容
2020年10月21日 龙腾蛟 自动发包工具使用指南

获取自动发包工具

运行前需要电脑安装有WinRAR。
git@git.sdp.nd:147741/AutoBuildTool4Vlab.git
运行AutoBuildTool4Vlab.exe后,会出现以下界面。正常情况下,用户只需填写红框中的四个信息,确认无误后点击“开始发包”按钮即可。发包工具会从管理平台下载三个最新的稳定包,调用WinRAR解压后替换其中的dll并修改配置文件,同时产生新的版本号,最后重新打包,整个过程需要3-5分钟。

名词解释

“原始包”:指从管理平台下载的,最新的开发版稳定包,一共有三个:PC播放器、PC编辑器、VR播放器,均为zip文件;
“原始包存放路径”:指上述三个包存放的目录;
“提测dll根目录”:放有本次提测的dll的根目录文件夹,建议选取”vlab-editor-4test\U3DProject\Assets\Plugins\NugetImport\GeneralAbility”,防止漏掉依赖的第三方dll。用户也可以将需要用到的dll拷贝出来放到一个单独的文件夹进行选取。(工具只会对目录下的dll文件进行拷贝);
“通用组件版本”:本次提测的dll的版本,需要满足”数字.数字.数字”的格式,比如”2.8.5”;
“测试包”:指原始包经过dll替换、配置文件更改、版本号变更等处理后产生的新包,也是三个zip文件,要上传到特性版

具体操作流程

运行发包工具

  1. 运行发包工具时,会自动获取管理平台上最新的应用包的下载链接,并显示在UI上;
  2. 如果自动获取的下载链接不满足需求,用户可以勾选“开启手动输入”后,手动填写下载链接。

填写发包需要的信息

  1. (可手动填写)下载原始包时,工具会在用户选定的路径下创建一个”VLabPackagesOrigin”文件夹,将下载的原始包存放在此文件夹下;
  2. 根目录中应包括通用能力组件的6个dll以及其依赖的第三方dll
  3. 填写本次提测的通用能力组件的版本号即可,暂不支持Beta等后缀;
  4. 创建测试包时,工具会在用户选定的路径下创建一个”VLabPackagesNew”文件夹,将创建的测试包存放在此文件夹下;

点击“开始发包按钮”

点击开始发包按钮后,工具会开始进行自动发包,具体表现如下:

首先根据下载链接获取三个原始包,原始包名称及下载进度如下图所示:

下载完成后,工具会对三个原始包进行解压、文件替换、再次压缩和重命名,创建新的提测包:

新的提测包全部创建完成后,会提示所在的目录,用户可以一键打开查看:

检查提测包(以PC播放器为例)

1.检查应用包版本号:
打开提测包根目录的”conf.ini”文件,检查”AppVersion”字段的值是否是新的版本号。

2.检查通用组件版本:
首先打开提测包根目录的”ModuleConfig.json”文件,检查”Engine”字段的值是否正确;
然后打开提测包的dll目录(一般是”xxx_Data/Managed”),按时间排列,检查通用能力组件dll的更新时间。

确认无误后,即可登录管理平台进行发包:https://vlab-developer.sdp.101.com/main.html#/app-list
注意要发到特性版!

注意事项

  1. 需安装有WinRAR;
  2. 基本原则:从开发版获取原始包,处理后得到测试包,测试包要发到特性版
  3. 下载原始包时,若规定的目录已经有了相同名字的原始包,则会把就原始包删除,然后再下载新的原始包;测试包同理。
  4. 若出现下载失败的情况,则需要重新启动发包工具,酌情选择手动下载,或者手动变更下载地址;
  5. 暂不支持断点续传,若在下载过程中关闭了工具,则再次运行时会从头下载;

配置文件说明

用户需要注意的中间的三组字段,三组字段结构相同,均是”xxxInter“+”xxxDllPath“+”xxxLatestInter“。
通常情况下,用户并不需要关心这些字段,但后续有需求时是可以酌情自行修改的。下面对这三个字段以及查询语句进行解释:

  1. “xxxInter“:查询语句,工具通过此字段来获取原始包
  2. “xxxDllPath“:原始包中,存放通用能力组件dll的路径;
  3. “xxxLatestInter“:查询语句,工具通过此字段获取提测包的名称,以及计算版本号。

查询语句:
通过查询语句,可以获取管理平台上特定状态下的最新包信息,比如:
https://vlab-service.sdp.101.com/v0.1/apps/latestVersion/TDLabPlayer_DEV?status=WAITPUBLISH,PUBLISHED,ONLINE
这条语句的意义是:获取在处于“待发布”、“已发布”、“已上线”状态中的PC播放器开发版的最新包的信息。
在浏览器网址中输入此语句,按回车后即可得到以下信息:

关于查询语句的更多信息可以在此查看:
https://wiki.doc.101.com/index.php?title=%E5%AE%9E%E9%AA%8C%E5%BC%80%E5%8F%91%E7%AE%A1%E7%90%86%E5%B7%A5%E5%85%B7-%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3