Skip to content

docs: 添加 Engine CI/CD 配置与复现 - #651

Open
Dame-time-0034 wants to merge 2 commits into
masterfrom
docs/engine-cicd
Open

Dame-time-0034 wants to merge 2 commits into
masterfrom
docs/engine-cicd

Conversation

@Dame-time-0034

Copy link
Copy Markdown
Contributor

改动内容

新增《Engine CI/CD 配置与复现》文档,放在「贡献相关」目录下。

文档只写了实际跑通并合入的步骤,附带排查记录,方便他人从空机器复现。

验证

  • 本地 mkdocs build 通过,页面渲染正常。
  • 仓库自带 tests/ 全部通过(含文档链接检查)。

@zheyexia10

Copy link
Copy Markdown
Contributor

审核结论:LGTM

已对照 OpenHUTB/engine#46 合入后的 Linux、Windows 和 Doxygen 工作流:文中的触发方式、依赖同步、测试报告判定、打包及 fork 发布条件与配置一致。新增流程图(1960×760)内容清晰,图片和 nav 链接有效;PR Build 成功。

非阻断建议:2.4 节可再明确写出“禁止将私有依赖令牌提交到工作流”,并优先生成 ${{ secrets.XXX }} 的示例。当前 engine 工作流仍硬编码凭据,应在该仓库尽快轮换并迁移到 Secrets。

本 PR 为文档变更,已附带流程图,无需额外效果图。

按 2026-11-15 在本机 runner 上的全流程复现结果更新文档:拆分 Linux 各步骤耗时、补充默认测试集的 21 条用例明细、修正 Windows 与 Setup 后的验证方式,并记录手动触发所需的仓库权限要求。
@Dame-time-0034

Copy link
Copy Markdown
Contributor Author

补充了一次提交,内容是按实机复现结果校正文档。

改动

  • 3.3 节:Linux 耗时改为按步骤拆分的表格(编译 33 分钟、自动化测试 19 秒、上传 4 秒、打包 67 分钟,合计 100 分钟);补充默认 TEST_FILTER 实测 21 条用例全部 Success。
  • 3.3 节:加入 2026-11-15 在 runner 主机上按本文步骤复现的记录(编译 30.6 分钟、测试 20 秒、打包 61 分钟、合计 96 分钟,各步骤返回码 0)。
  • 4 节:Windows 耗时改为实测的 128 分钟与 357 分钟。
  • 6 节:修正验证节点——干净工作区里 Setup.sh 之后 UnrealBuildTool.exe 仍不存在(由后续编译生成),改为核对 Setup successful.、Build.sh 的 Running command : ... UE4Editor Linux Development 与 Total execution time。
  • 6 节:补充手动触发需要仓库写权限,权限不足时 API 返回 403 Must have admin rights to Repository.。

验证

  • mkdocs build 通过(26 个页面,无 ERROR);tests/test_docs_links.py 通过;页面 LF 换行、无制表符与行尾空格,代码块均带语言标记且成对闭合,表格分隔行全页统一。
  • Linux 流水线在实机完整跑通:依赖同步 → 生成工程 → 编译(UBT Total execution time: 1838.42 seconds,2780/2780)→ 自动化测试(succeeded=21 failed=0 notRun=0)→ 报告解析 → 打包 Installed Build(BUILD SUCCESSFUL,ExitCode=0),15:56:51 开始、17:33:17 结束。

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants