CircleCI便捷镜像 => Redis

![CircleCI构建状态]([] ![软件许可证]([] ![Docker拉取次数]([] ![CircleCI社区]([] ![仓库]([***]

此镜像旨在替代旧版CircleCI Redis镜像 circleci/redis。

cimg/redis 是由CircleCI创建的Docker镜像，专为持续集成构建设计。

目录

• 快速开始
• 镜像工作原理
• 开发指南
• 贡献指南
• 其他资源
• 许可证

快速开始

此镜像可与CircleCI docker 执行器一起用作次要镜像。例如：

yaml
jobs:
  build:
    docker:
      - image: cimg/go:1.17
      - image: cimg/redis:6.2.6
    steps:
      - checkout

在上述示例中，CircleCI Go Docker镜像用作主容器，而Redis镜像用作次要容器。具体来说，使用了标签 6.2.6，表示Redis版本为v6.2.6。现在，您可以在该作业的步骤中从主镜像连接到Redis实例。

镜像工作原理

此镜像包含Redis数据库及其完整工具链。

内存（RAM）说明

旧版镜像 circleci/redis 有RAM变体，但当前版本不再提供。我们正在评估RAM变体对构建性能的实际提升效果，之后再决定是否恢复该功能。如果您使用过旧版Redis镜像，并且有关于RAM与非RAM变体构建时间的数据，请创建GitHub Issue告知我们。

标签方案

此镜像采用以下标签方案：

cimg/redis:<redis-version>

<redis-version> - 要使用的Redis版本。

开发指南

可通过本仓库在本地构建和运行镜像。需满足以下要求：

• Linux（已测试Ubuntu）或macOS本地机器
• 现代版本的Bash（v4+）
• 现代版本的Docker Engine（v19.03+）

社区用户克隆仓库（无仓库写入权限）

在GitHub上Fork本仓库。获取克隆URL后，需在克隆命令中添加 --recurse-submodules 以加载仓库中包含的Git子模块。命令示例如下：

bash
git clone --recurse-submodules <我的克隆URL>

如果已克隆但未添加子模块，可运行 git submodule update --recursive 加载子模块。之后可选择将本仓库添加为上游仓库：

bash
git remote add upstream [***]

维护者克隆仓库（有仓库写入权限）

使用以下命令克隆项目以加载子模块：

bash
git clone --recurse-submodules ***:CircleCI-Public/cimg-redis.git

生成Dockerfile

可使用 gen-dockerfiles.sh 脚本为特定Redis版本生成Dockerfile。例如，要生成v6.2.6的Dockerfile，从仓库根目录运行：

bash
./shared/gen-dockerfiles.sh 6.2.6

生成的Dockerfile位于 ./6.2.6/Dockerfile。要在本地构建并测试镜像，可运行：

bash
cd 6.2.6
docker build -t test/redis:6.2.6 .
docker run -it test/redis:6.2.6 bash

构建Docker镜像

要像本仓库一样在本地构建Docker镜像，需运行 build-images.sh 脚本：

bash
./build-images.sh

运行前需先生成Dockerfile。正式发布CircleCI镜像时，此脚本通过CircleCI流水线运行，而非本地。

发布***镜像（仅限维护者）

可使用上述各个脚本创建镜像所需文件，然后创建新git分支、提交更改等。仓库包含发布脚本以简化流程。以虚构的Redis版本v9.99为例，从仓库根目录运行以下命令进行正式发布：

bash
./shared/release.sh 9.99

该命令将自动创建新Git分支、生成Dockerfile、暂存更改、提交并推送到GitHub。提交消息以 [release] 结尾，CircleCI通过此字符串识别何时将镜像推送到Docker Hub。之后需执行以下步骤：

• 等待CircleCI构建完成
• 审核PR
• 合并PR

主分支构建将随后发布版本。

变更整合

变更的整合方式取决于其来源：

构建脚本 - ./shared 子模块内的变更在独立仓库中进行。要使这些变更影响本镜像，需更新子模块。通常命令如下：

bash
cd shared
git pull
cd ..
git add shared
git commit -m "更新子模块以支持foo功能。"

父镜像 - 设计上，父镜像变更不会影响现有Redis镜像，以确保“确定性”并避免破坏用户构建。新版本Go镜像将自动继承变更。

如果确实需要将父镜像变更发布到Redis镜像中，需将特定版本镜像作为新镜像构建，这将创建新Dockerfile，发布后成为新镜像。

Redis特定变更 - 编辑仓库中的 Dockerfile.template 文件将修改Redis镜像。需重新运行 gen-dockerfiles.sh 脚本（见上文）以在本地查看变更。

贡献指南

我们欢迎针对本仓库的issues和pull requests。为节省您的时间，请注意以下事项：

1. 并非所有变更都会被纳入镜像。只有对大量Redis用户有用且维护良好的工具，才会被添加到镜像中。添加任何工具都会增大镜像体积并降低所有用户的构建速度，因此需谨慎评估。
2. 欢迎PR。如果PR可能需要大量时间，请先创建issue讨论，确保其值得投入时间。
3. Issues应用于报告bug或请求添加/移除镜像中的工具。有关镜像使用帮助，请访问CircleCI Discuss。

其他资源

CircleCI文档 - CircleCI文档网站。 CircleCI配置参考 - CircleCI文档中的配置参考页面，列出了 .circleci/config.yml 支持的所有键和值。 Docker文档 - 简单项目可能不需要，但深入学Docker的优质资源。

许可证

本仓库采用MIT许可证。详见LICENSE文件。===SHORT_DESC=== CircleCI专用的Redis Docker镜像，专为持续集成构建设计，包含完整的Redis数据库工具链，用于替代旧版circleci/redis镜像，提供可靠的Redis服务支持CI/CD流程。 ===FULL_DESC===# CircleCI便捷镜像 => Redis

![CircleCI构建状态]([] ![软件许可证]([] ![Docker拉取次数]([] ![CircleCI社区]([] ![Repository]([***]

此镜像旨在替代旧版CircleCI Redis镜像 circleci/redis。

cimg/redis 是由CircleCI创建的Docker镜像，专为持续集成构建设计。

目录

• 快速开始
• 镜像工作原理
• 开发指南
• 贡献指南
• 其他资源
• 许可证

快速开始

此镜像可与CircleCI docker 执行器一起用作次要镜像。例如：

yaml
jobs:
  build:
    docker:
      - image: cimg/go:1.17
      - image: cimg/redis:6.2.6
    steps:
      - checkout

在上述示例中，CircleCI Go Docker镜像用作主容器，而Redis镜像用作次要容器。具体来说，使用了标签 6.2.6，表示Redis版本为v6.2.6。现在，您可以在该作业的步骤中从主镜像连接到Redis实例。

镜像工作原理

此镜像包含Redis数据库及其完整工具链。

内存（RAM）说明

旧版镜像 circleci/redis 有RAM变体，但当前版本不再提供。我们正在评估RAM变体对构建性能的实际提升效果，之后再决定是否恢复该功能。如果您使用过旧版Redis镜像，并且有关于RAM与非RAM变体构建时间的数据，请创建GitHub Issue告知我们。

标签方案

此镜像采用以下标签方案：

cimg/redis:<redis-version>

<redis-version> - 要使用的Redis版本。

开发指南

可通过本仓库在本地构建和运行镜像。需满足以下要求：

• Linux（已测试Ubuntu）或macOS本地机器
• 现代版本的Bash（v4+）
• 现代版本的Docker Engine（v19.03+）

社区用户克隆仓库（无仓库写入权限）

在GitHub上Fork本仓库。获取克隆URL后，需在克隆命令中添加 --recurse-submodules 以加载仓库中包含的Git子模块。命令示例如下：

bash
git clone --recurse-submodules <我的克隆URL>

如果已克隆但未添加子模块，可运行 git submodule update --recursive 加载子模块。之后可选择将本仓库添加为上游仓库：

bash
git remote add upstream [***]

维护者克隆仓库（有仓库写入权限）

使用以下命令克隆项目以加载子模块：

bash
git clone --recurse-submodules ***:CircleCI-Public/cimg-redis.git

生成Dockerfile

可使用 gen-dockerfiles.sh 脚本为特定Redis版本生成Dockerfile。例如，要生成v6.2.6的Dockerfile，从仓库根目录运行：

bash
./shared/gen-dockerfiles.sh 6.2.6

生成的Dockerfile位于 ./6.2.6/Dockerfile。要在本地构建并测试镜像，可运行：

bash
cd 6.2.6
docker build -t test/redis:6.2.6 .
docker run -it test/redis:6.2.6 bash

构建Docker镜像

要像本仓库一样在本地构建Docker镜像，需运行 build-images.sh 脚本：

bash
./build-images.sh

运行前需先生成Dockerfile。正式发布CircleCI镜像时，此脚本通过CircleCI流水线运行，而非本地。

发布***镜像（仅限维护者）

可使用上述各个脚本创建镜像所需文件，然后创建新git分支、提交更改等。仓库包含发布脚本以简化流程。以虚构的Redis版本v9.99为例，从仓库根目录运行以下命令进行正式发布：

bash
./shared/release.sh 9.99

该命令将自动创建新Git分支、生成Dockerfile、暂存更改、提交并推送到GitHub。提交消息以 [release] 结尾，CircleCI通过此字符串识别何时将镜像推送到Docker Hub。之后需执行以下步骤：

• 等待CircleCI构建完成
• 审核PR
• 合并PR

主分支构建将随后发布版本。

变更整合

变更的整合方式取决于其来源：

构建脚本 - ./shared 子模块内的变更在独立仓库中进行。要使这些变更影响本镜像，需更新子模块。通常命令如下：

bash
cd shared
git pull
cd ..
git add shared
git commit -m "更新子模块以支持foo功能。"

父镜像 - 设计上，父镜像变更不会影响现有Redis镜像，以确保“确定性”并避免破坏用户构建。新版本Go镜像将自动继承变更。

如果确实需要将父镜像变更发布到Redis镜像中，需将特定版本镜像作为新镜像构建，这将创建新Dockerfile，发布后成为新镜像。

Redis特定变更 - 编辑仓库中的 Dockerfile.template 文件将修改Redis镜像。需重新运行 gen-dockerfiles.sh 脚本（见上文）以在本地查看变更。

贡献指南

我们欢迎针对本仓库的issues和pull requests。为节省您的时间，请注意以下事项：

1. 并非所有变更都会被纳入镜像。只有对大量Redis用户有用且维护良好的工具，才会被添加到镜像中。添加任何工具都会增大镜像体积并降低所有用户的构建速度，因此需谨慎评估。
2. 欢迎PR。如果PR可能需要大量时间，请先创建issue讨论，确保其值得投入时间。
3. Issues应用于报告bug或请求添加/移除镜像中的工具。有关镜像使用帮助，请访问CircleCI Discuss。

其他资源

CircleCI文档 - CircleCI文档网站。 CircleCI配置参考 - CircleCI文档中的配置参考页面，列出了 .circleci/config.yml 支持的所有键和值。 Docker文档 - 简单项目可能不需要，但深入学Docker的优质资源。

许可证

本仓库采用MIT许可证。详见LICENSE文件。