C / C++ / 系统课时
生成最终 Release 构建产物
生成最终 Release 构建产物
开发阶段能运行并不等于可以发布。本节把工程切换到 Release 配置,从独立构建目录重新配置、编译并执行全部测试,随后运行 CMake 安装流程,把真正需要交付的可执行文件整理到独立发布目录中。
学习目标
- 使用独立目录生成并编译 Release 版本,避免混入 Debug 构建结果
- 在发布前通过 CTest 执行全部测试,并正确处理失败情况
- 使用 CMake 安装流程生成结构清晰、可检查的最终发布目录
从干净的 Release 目录开始
最终发布构建不要直接复用日常 Debug 目录。CMake 会在构建目录保存生成器、编译选项和缓存变量,单独使用 build-release 可以减少旧缓存或调试配置混入发布结果的风险。
下面以单配置生成器为例。项目需要已经定义可构建目标、测试以及 install() 安装规则;<PATH> 表示项目的绝对路径,实际值因机器而异。
cd <PATH>
cmake -S . -B build-release -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<PATH>/dist预期输出
-- Configuring done
-- Generating done
-- Build files have been written to: <PATH>/build-release这里的关键不是目录名称,而是让 Release 构建拥有独立缓存。可以进一步检查缓存中的构建类型:
cmake -N -L build-release预期输出中应能看到类似内容,其他缓存项会因项目和平台不同而变化:
CMAKE_BUILD_TYPE:STRING=Release
CMAKE_INSTALL_PREFIX:PATH=<PATH>/dist编译并运行全部测试
配置成功后先完成编译,再运行测试。只有编译和测试都通过,当前提交才适合作为发布候选产物。
cmake --build build-release --parallel
ctest --test-dir build-release --output-on-failure预期输出
[100%] Built target <TARGET>
Test project <PATH>/build-release
100% tests passed, 0 tests failed out of <ID><TARGET> 和 <ID> 分别代表项目中的实际目标名与测试数量。若测试失败,--output-on-failure 会显示失败测试的输出,此时应停止发布流程,而不是继续执行安装后把未经验证的二进制文件交付出去。
执行安装并检查发布目录
不要把 build-release 整个目录当成发布包。构建目录通常包含缓存、对象文件和生成器内部文件;真正的交付内容应由项目的 install() 规则决定。
cmake --install build-release预期输出
-- Install configuration: "Release"
-- Installing: <PATH>/dist/bin/<TARGET>安装后检查发布目录。下面的命令只关注已经安装的文件,而不是构建中间产物:
find <PATH>/dist -type f -print预期输出
<PATH>/dist/bin/<TARGET>如果项目还会安装配置模板、动态库或其他运行时资源,列表中会出现相应文件。最终目录应只包含项目明确声明要交付的内容;若 cmake --install 几乎没有产生文件,应检查 CMakeLists.txt 中是否定义了正确的 install(TARGETS ...)、install(FILES ...) 等规则。
多配置生成器要显式选择 Release
Visual Studio、Xcode 等多配置生成器可以在同一个构建目录中同时管理 Debug 和 Release,因此 CMAKE_BUILD_TYPE 通常不起决定作用。此时应在编译、测试和安装三个阶段都显式指定 Release。
cmake -S . -B build
cmake --build build --config Release --parallel
ctest --test-dir build -C Release --output-on-failure
cmake --install build --config Release --prefix <PATH>/dist预期输出
100% tests passed, 0 tests failed out of <ID>
-- Install configuration: "Release"
-- Installing: <PATH>/dist/bin/<TARGET>单配置生成器和多配置生成器的目标相同:最终被测试和安装的必须是 Release 二进制,而不是误用 Debug 版本。
发布前做最终验收
最后一次验收应围绕“交付目录能否独立使用”进行,而不是只检查构建目录。至少确认测试全部通过、安装命令成功、dist 中不存在对象文件和 CMake 缓存,并实际运行安装后的命令行程序。
<PATH>/dist/bin/<TARGET> --help预期输出
<PROGRAM_HELP_OUTPUT><PROGRAM_HELP_OUTPUT> 表示该工具真实的帮助信息,内容由项目自身决定。如果程序能够从安装目录正常启动,全部自动化测试通过,而且发布目录只包含预期文件,就得到了一份可以继续压缩、签名或交付给用户的 Release 产物。