关于换皮游戏项目的维护

需求

公司有一个成熟的游戏项目，合作方有多个ip，双方决定以该项目换皮，推出不同风格的游戏。

环境

版本控制使用 git，游戏引擎使用egret

解决方案

1.git submodule

整个项目结构上我们分为 引擎+业务代码两个部分。引擎部分作为一个单独的库，用来维护底层源码，整个项目以submodule的模式引入引擎库，这样引擎层面做bug修复、引擎更新等，项目直接更新子项目即可。

注释：egret 比较特殊，项目中实际上使用的是导出压缩的js代码，公司当前项目未使用submodule，而是把引擎模块作为一个单独的库维护、更新引擎库导出的js。不过submodule方案对于 cocos2d-x 等开源的非脚本语言引擎来说是个比较好的维护方案。

常用命令

初始配置

git submodule add <repository> <path> #添加子模块
git submodule init #初始化子模块
git submodule update #更新子模块
git submodule foreach git pull #拉取所有子模块

后续维护
子模块的维护者提交了更新后，使用子模块的项目必须手动更新才能包含最新的提交。

cd <子模块路径>
git pull #拉取更新
cd <项目根目录>
git add <changes>  #子模块有待提交的更新
git commit #提交子模块更新

一些注意事项可以参考这篇优秀的博文。

2.合并两个项目

对于业务代码部分，如果两个项目差异不大可以通过git 直接将一个项目合入到另外一个中。
以把项目A 合入到 项目B为例，在B项目目录进行以下操作：

git checkout -b <临时分支名> #新建一个分支
git remote -v #查看当前项目的远程仓库
remote add <远端A别名> <http://ip/项目地址A.git> #添加一个远端源
git remote -v #确认一下添加成功
git merge --squash --allow-unrelated-histories <远端A别名/分支名> #合并指定分支
git add .
git commit 提交

后续可以通过以下两种方式合入主分支
1> 如果有主分支操作权限，本地合并临时分支到主分支然后推送
2> 推送临时分支名到远端，在项目管理后台，由code reviewer合并到主分支

在merge时 如果项目中使用了 lfs可能会遇到的错误
XXXX Object does not exist on the server or you don’t have permissions to access it.
fatal: src/client/xxx/xxx/xxx.png: smudge filter lfs failed.
做如下处理:
git checkout . #还原变更
git clean -ifd #做下清理
git lfs fetch --all <远端A别名> #拉取远端A的lfs文件 NOTE：我在这一步有出现上边的 not exist/permissions 提示我怀疑是某些文件删除导致的，查了一圈没找到如何通过pointer查看源文件； 由于没有影响后续操作、没有深究，有了解的朋友可以留言指点一下
继续执行merge 操作
git lfs prune #所有工作结束后清理lfs