元器件基类出包

更新记录

版本 日期 修改人 修改内容
2.0.0 2027年8月27日 康振田(940615) 修改补丁版本规则
1.0.0 2027年8月27日 康振田(940615) 新建文档

基类审核

  1. 基类代码是维护在Gerrit平台的,Develop所有的代码都需要经过审核以后才能合并到Develop分支上面。基类出包目前是采取一个版本一个分支来维护的,每个版本要出的新功能都通过Git的CherryPick功能从Develop分支摘取指定的提交到对应的版本分支上出。
  2. 审核人员由各科组长进行审核,并确定该功能出包的优先级。并确定审核通过,出在具体的版本下,并通过cherrypick命令,下载到具体的分支下进行出包。在该内容通过后,再审核通道。
  3. 与组件,应用端,策划,老师联调需要改到基类的,则需要基于develop分支创建特性分支,由于有时联调时需要出特性包,但是由于lua的特性基类包无法通过,所以建版本时需要注意,有可能建立的版本后续需要删除(或者直接在特性分支上打包,让其需要的人员手动替换)。
    注意: 联调测试特性包通过后,特性分支上的代码git提交记录如果有多条,请合并成一条(不清晰的可咨询(940615),具体步骤下次遇到后补充),在上传到gerrit上进行审核。并在正式包通过后,审核通过
  4. 补丁版本,即基于上一个版本分支创建版本即可。默认情况下版本号为3位数:xx.xx.xx
    在一些特殊情况下(比如要在连续的两个版本中间再插入一个版本)可以再后面再加一位,比如要在3.3.3和3.3.4中插入一个版本号,可以出一个3.3.3.1的版本。
  5. 基类资源包,即分为 VLabCommonResource,VLabElementResource出包规则与脚本代码一致, 基类脚本包要与基类的资源对应,即功能需求要与具体的资源包资源一一对应

出包分支创建规则(hotfix版本外全部基于develop分支创建)

  1. release出包规则分支名称由各科组长确定具体版本号
    分支名称为:
    脚本包:
    VLabCommonLua: release/vlc/xx.xx.xx
    VLabElementBase:release/vle/xx.xx.xx

资源包:
VLabCommonResource:release/vlcRes/xx.xx.xx
VLabElementResource: release/vleRes/xx.xx.xx

  1. feature出包分支名称根据具体功能命名,基于develop分支创建
    分支名称:
    feature/xxx(功能名称): eg: feature/joint

  2. hotfix出包规则,基于该版本的上一个版本分支创建分支,如果是上一个版本与develop一致,则在develop分支创建即可
    分支名称:
    VLabCommonLua: hotfix/vlc/xx.xx.xx
    VLabElementBase:hotfix/vle/xx.xx.xx

资源包:
VLabCommonResource:hotfix/vlcRes/xx.xx.xx/
VLabElementResource: hotfix/vleRes/xx.xx.xx/

基类版本敲定规则(版本号屏蔽数字4)

  1. 首位版本的提升应在出现基类重大结构变动时,导致VLabCommonLua(Lua)不再兼容旧版本的VLabElemenetBase(Base)时提升,比如VLabCommonLua中有文件被迁移到了VLabElementBase中,这种情况下VLabCommonLua就没法兼容旧的VLabElementBase,需要同时提升Lua和Base的首位版本号
    eg: 3.3.10 ===》》》 5.0.0

  2. 次位版本号用于当末位版本号超过100时进1。
    eg:
    基于3.3.10版本进行升级
    如果引擎和播放器版本提升了,则下个版本号为 3.5.10
    如果引擎和播放器版本没有提测,则下个版本号为 3.3.20

  3. 末位版本号规则直接加10,如果是补丁版本则加1
    eg:
    正常版本 3.3.10 ===》》》 3.3.20
    补丁版本 3.3.10 ===》》》 3.3.11
    补丁版本之间加版本,在3.3.10与3.3.11之间加版本 3.3.10 ===》》》 3.3.10.1

出包流程

  1. 切到对应分支下进行打包
    打包之前与上一个版本(该处正常指的即是develop分支,其他特殊情况根据情况具体分析)进行比较差别,进行打包前的最后一次检查
  2. 针对打包内容进行自测
  3. 提交版本计划(因为基类的开发内容存在着版本合并,拆分等,所以版本计划会乱,如果提测前该版本还么有版本计划,则进行创建版本计划),通过后进行提测即可

打包工具

打开编辑器,通过TOOL\LuaTools\基类打包工具进行打包
打出来的包会放在VlabEquip\AutoObjUpload\元器件自动上传工具\LabObjPackage文件夹下

——TODO 后续有需求,不足之处再补充