netlify/build

Netlify Build Image

镜像概述和主要用途

Netlify Build Image是Netlify用于从Git仓库构建网站的构建工具镜像，主要用于持续部署流程。开发者可使用该镜像在本地测试构建问题，复现线上构建环境，排查因环境差异导致的构建失败，确保代码部署前构建正常。

核心功能和特性

• 模拟Netlify线上构建环境，支持从Git仓库构建网站
• 提供本地测试能力，帮助复现和排查构建问题
• 集成缓存机制，可保留构建缓存数据，提升调试效率
• 支持详细的shell输出，便于查看构建过程中的详细日志
• 提供交互模式运行，支持在容器内直接执行自定义构建命令

使用场景和适用范围

适用于使用Netlify进行网站持续部署的开发者，在本地开发阶段测试构建流程，验证构建命令、依赖环境等是否符合Netlify部署要求，避免因环境差异导致线上构建失败。

使用方法和配置说明

本地测试构建

1. 克隆代码仓库到本地目录。若有未提交的本地修改，需先提交更改并确保处于对应分支，否则构建过程会忽略未提交的修改。
2. 在build-image仓库的根目录，使用工具脚本以交互模式运行镜像，将你的仓库路径作为参数挂载为卷：

   bash
   ./test-tools/start-image.sh path/to/my/repo
   

3. 在容器内，使用build脚本执行自定义构建命令，模拟Netlify构建环境：

   bash
   build jekyll build  # 将`jekyll build`替换为你的实际构建命令（如`npm run build`）
   

带缓存的本地测试

若需使用缓存机制进行调试，并获取详细的shell输出，可使用test-build.sh工具脚本：

bash
test-tools/test-build.sh path/to/your/repo 'your build command'

该命令会自动创建临时目录，包含克隆的仓库文件、缓存数据（含隐藏文件）及执行脚本。若需重复使用相同缓存，可通过T环境变量指定缓存目录：

bash
T=tmp/tmp.XXXXX test-tools/test-build.sh path/to/your/repo 'your build command'

（其中tmp/tmp.XXXXX为首次运行时生成的临时目录路径）

贡献指南

欢迎提交Pull Request，建议聚焦通用场景需求，避免针对小众使用场景的过度定制化修改。

更多信息

关于Netlify构建流程及最佳实践，可参考官方文档：How our build bots build sites