首页
/ 解决mdBook在GitLab CI/CD中测试失败的问题

解决mdBook在GitLab CI/CD中测试失败的问题

2025-05-11 09:55:36作者:侯霆垣

在使用mdBook构建文档时,很多开发者会选择通过GitLab CI/CD实现自动化构建和部署。然而,在执行mdbook test命令时可能会遇到"Error: No such file or directory (os error 2)"的错误,而同样的命令在本地开发环境却能正常运行。

问题根源分析

这个问题的根本原因是缺少rustdoc工具。mdBook的测试功能依赖于Rust的文档测试工具链,特别是rustdoc命令。当在GitLab CI/CD环境中运行时,如果没有安装Rust工具链,或者rustdoc不在PATH环境变量中,就会导致测试失败。

解决方案

要解决这个问题,需要在CI/CD环境中正确安装Rust工具链:

  1. 首先安装必要的依赖:
apt update
apt install -y openssh-client rsync curl
  1. 安装Rust工具链(非交互式安装):
curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs | sh -s -- -y
  1. 将Rust工具链添加到PATH:
export PATH=~/.cargo/bin:$PATH
  1. 安装并运行mdBook:
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=.
./mdbook build
./mdbook test

注意事项

  1. 在Ubuntu 24.04等系统中,通过apt安装的Rust版本可能较旧(如1.75),而mdBook 0.44.4需要Rust 1.77或更高版本。因此建议使用rustup安装最新版本,而不是依赖系统包管理器。

  2. 在CI/CD环境中执行非交互式安装时,必须使用-y参数自动接受所有安装选项。

  3. 确保~/.cargo/bin被正确添加到PATH环境变量中,否则系统仍然找不到rustdoc命令。

  4. 如果后续步骤需要其他工具(如rsync用于部署),也需要提前安装。

完整示例

以下是一个完整的GitLab CI/CD脚本示例,包含了文档构建、测试和部署的全过程:

# 安装基础依赖
apt update
apt install -y openssh-client rsync curl

# 设置SSH密钥(用于部署)
install -m 600 -D /dev/null ~/.ssh/id_ed25519
echo $SSH_PRIVATE_KEY | base64 -d > ~/.ssh/id_ed25519
ssh-keyscan -H $SSH_HOST > ~/.ssh/known_hosts

# 安装Rust工具链
curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs | sh -s -- -y
export PATH=~/.cargo/bin:$PATH

# 下载并安装mdBook
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=.

# 构建和测试文档
./mdbook build
./mdbook test

# 复制额外资源(如favicon)
cp ./data/favicon.* ./book/

# 部署到远程服务器
rsync -r --delete ./book/ $SSH_USER@$SSH_HOST:$MDBOOK_PATH

通过以上步骤,可以确保mdBook在GitLab CI/CD环境中能够正确执行测试功能,顺利完成文档的自动化构建和部署流程。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
152
1.97 K
kernelkernel
deepin linux kernel
C
22
6
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
426
34
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
239
9
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
988
394
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
936
554
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
69