UE Project Git Pull&Build

自动关联目录:UE Project Git Pull&Build

目的:用 UGit 管理项目,设置定时任务每日自动唤醒计算机并执行该脚本——早上到工位时,代码已经是最新的、编辑器已经编译好并打开了。

省下的是每天开工前那 10~30 分钟的 pull + 编译 + 启动,代价是要容忍一个"无人值守"的自动化流程可能出各种岔子。

脚本

@echo off
setlocal enabledelayedexpansion

rem 获取脚本所在目录
set "script_dir=%~dp0"

rem 定义一个数组来存储所有仓库的相对路径
set "repos[0]=XXXXX\"
set "repos[1]=XXXXX\Plugins\"
set "repos[2]=YYYYY\"
set "repos[3]=XXXXX_common\"
set "repos[4]=XXXXX\Content\Feature\ZZZZZ\"

rem 初始化仓库计数器
set "repo_count=0"

rem 计算数组的长度
:SymLoop 
if defined repos[%repo_count%] ( 
    set /a "repo_count+=1"
   GOTO :SymLoop 
)

echo Processing %repo_count% repositories.

set /a "repo_count-=1"

taskkill /F /IM UE4Editor.exe /T

taskkill /F /IM rider64.exe /T

rem 遍历所有仓库
for /l %%i in (0, 1, %repo_count%) do (

    rem 构建仓库的完整路径
    set "repo_path=!script_dir!!repos[%%i]!"

    echo Processing repository: !repo_path!

    rem 进入仓库目录
    cd /d "!repo_path!"

    rem 删除所有锁文件
    del ".git\index.lock"

    rem 获取当前 Git 分支名
    for /f %%i in ('git rev-parse --abbrev-ref HEAD') do (
        set branch_name=%%i
    )

    echo "Current branch: !branch_name!"

    rem 拉取最新代码
    call git fetch --progress --recurse-submodules=on-demand origin %branch_name%
    call git pull origin %branch_name%
)

echo All repositories processed.

rem 返回上级目录
cd /d "!script_dir!"

echo Start Building...
call !script_dir!YYYYY\Engine\Build\BatchFiles\Build.bat -Target="XXXXXEditor Win64 Development -Project=\"!script_dir!XXXXX\XXXXX.uproject\"" -Target="ShaderCompileWorker Win64 Development -Quiet" -WaitMutex -FromMsBuild
echo End   Building...

start rider64.exe "!script_dir!XXXXX\XXXXX.sln"

start code "!script_dir!XXXXX\XXXXX.code-workspace"

start !script_dir!YYYYY\Engine\Binaries\Win64\UE4Editor.exe !script_dir!XXXXX\XXXXX.uproject

endlocal

流程拆解

步骤命令说明
1. 清场taskkill /F /IM UE4Editor.exe /T编辑器/IDE 会锁住 .dll 与 .pdb,不关会编译失败
2. 清锁del .git\index.lock上次异常中断留下的锁文件会让 git 直接报错
3. 取分支git rev-parse --abbrev-ref HEAD每个仓库分支可能不同,别写死
4. 拉取fetch --recurse-submodules=on-demand + pull子模块按需递归,UE 工程通常有引擎/插件子模块
5. 编译Build.bat同时编 Editor 与 ShaderCompileWorker
6. 启动start 三个进程IDE、编辑器、代码工作区

要点:编译 ShaderCompileWorker 和 Editor 放在一条命令里,-WaitMutex 避免和其它构建进程抢同一个互斥量,-FromMsBuild 让输出格式对 IDE 友好。

为什么是多个仓库

UE 工程通常被拆成若干独立仓库:

XXXXX\                        主工程
XXXXX\Plugins\                插件(独立版本节奏)
YYYYY\                        引擎(大仓库,少动)
XXXXX_common\                 跨项目公共库
XXXXX\Content\Feature\ZZZZZ\  大内容目录(美术分支独立)

拆开的好处是拉取与权限可控,代价是必须保证它们的版本互相兼容——脚本按顺序 pull,但不会检查兼容性,所以偶尔会出现"拉完就编不过"。

无人值守的必备措施

风险对策
pull 因本地改动失败定时任务是自动执行,不能依赖人工解决冲突:执行前 git reset --hard + clean -fd(前提:确认工作区不留东西)
锁文件残留提前 del index.lock
编译失败无人知道输出重定向到日志,失败时发通知/写标记文件
脚本卡死给 git 与 Build.bat 加超时
唤醒后网络未就绪拉取前先 ping/重试几次
磁盘被构建产物撑满定期清理 Intermediate、Saved
编辑器崩溃残留taskkill 覆盖 UE4Editor / CrashReporterClient / ShaderCompileWorker

最重要的一条:脚本要能"失败得明明白白"。加 %ERRORLEVEL% 检查与日志,否则早上到工位只看到一个没打开的编辑器,却不知道哪一步挂了。

改进方向

方向说明
换成 PowerShell / Pythonbat 的数组与延迟展开(本脚本里那些 !var!)可读性极差,错误处理也弱
并行拉取各仓库互不依赖,可以并发 git fetch,几倍提速
增量/条件构建无新提交时跳过编译
用 CI 替代真正的解法是交给构建机,本地只同步产物(DDC、二进制)——个人脚本终究是权宜之计
记录构建指标每次耗时、失败原因,用来判断"是不是该清理/换机器了"

常见坑

坑说明
忘了 setlocal enabledelayedexpansion循环里的 !var! 全部失效
分支名用中文/带空格for /f 解析会截断
路径含空格却没加引号cd 直接失败
编辑器没杀干净编译最后链接时 cannot open file .dll for writing
子模块没拉全编译期才报缺文件,或运行时崩
编译产物被占用同 -WaitMutex 的其它构建(手动开的 IDE 构建)抢锁