connectedhomeip/chip-build

connectedhomeip:chip-build Docker镜像文档

镜像概述和主要用途

connectedhomeip/chip-build是CHIP项目用于持续集成和其他构建任务的Docker镜像。该镜像提供了标准化的构建环境，确保开发和CI过程中工具链的一致性。镜像相关文件包含在特定目录中，包括构建脚本、版本控制文件和镜像描述文件。

核心功能和特性

• 标准化构建环境：提供CHIP项目构建所需的完整工具链和依赖
• 版本化管理：通过version文件采用semver风格进行版本控制
• 构建脚本支持：包含build.sh脚本，用于本地构建、标记和推送镜像
• 灵活的更新机制：明确的工具更新与版本号递增规则

目录内容说明

• build.sh：用于构建（可选标记和推送）chip-build Docker镜像的工具脚本
• version：当前CHIP分支所使用的镜像semver风格版本号
• Dockerfile：镜像的描述文件，定义构建环境配置

使用场景和适用范围

• CHIP项目的持续集成流程
• 本地开发环境的标准化构建
• 确保团队成员使用一致的构建工具版本
• 构建工具链更新和版本管理

使用方法和配置说明

版本更新指导原则

当需要更新镜像中的工具或依赖时，需同步更新version文件，遵循以下规则：

• 更新工具：除非工具存在主版本变更或向后不兼容，否则仅递增点版本（如0.2.1 → 0.2.2）
• 添加工具：递增次要版本（如0.2.1 → 0.3.0）
• 删除工具：递增主版本（如1.2 → 2.0）

典型使用流程

1. 识别新的构建工具依赖
2. 将工具添加到Dockerfile中
3. 更新version文件的版本号
4. 执行本地构建：

   bash
   $ ./build.sh
   

   此命令会将新镜像安装为本地新版本
5. 在devcontainer.json中更新镜像版本
6. 验证新镜像在本地构建是否正常工作
7. 登录Docker Hub：

   bash
   $ docker login
   

8. 推送镜像（仅主分支可添加--latest标记）：

   bash
   $ ./build.sh --push --latest
   

注意事项

• 推送镜像到Docker Hub的connectedhomeip:chip-build仓库需要特权访问权限
• 除非在主分支上，否则推送时应省略--latest标记，避免覆盖最新稳定版本