CircleCI 便捷镜像 => MariaDB

专为在 CircleCI 上运行而构建的、专注于持续集成的 MariaDB Docker 镜像

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

此镜像旨在取代旧版 CircleCI MariaDB 镜像 circleci/mariadb。

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

支持政策

CircleCI Docker 便捷镜像的支持政策可在 CircleCI 文档 网站上找到。该政策概述了 CircleCI Docker 便捷镜像的发布、更新和弃用政策。

目录

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

快速开始

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

yaml
jobs:
  build:
    docker:
      - image: cimg/go:1.17
      - image: cimg/mariadb:10.6.4
    steps:
      - checkout

在上述示例中，CircleCI Go Docker 镜像用作主容器，而 MariaDB 镜像用作次要容器。具体来说，使用了标签 10.6.4，这意味着将使用 MariaDB v10.6.4 版本。现在，您可以在此作业的步骤中从主镜像连接到 MariaDB 实例。

镜像工作原理

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

内存（RAM）

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

标签方案

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

cimg/mariadb:<mariadb-version>

<mariadb-version> - 要使用的 MariaDB 版本。

开发指南

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

• 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 来填充子模块。然后可以选择将本仓库添加为您 Fork 仓库的上游仓库：

bash
git remote add upstream [***]

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

使用以下命令克隆项目以填充子模块：

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

生成 Dockerfile

可以使用 gen-dockerfiles.sh 脚本为特定的 MariaDB 版本生成 Dockerfile。例如，要生成 v10.6.4 的 Dockerfile，从仓库根目录运行以下命令：

bash
./shared/gen-dockerfiles.sh 10.6.4

生成的 Dockerfile 将位于 ./10.6.4/Dockerfile。要在本地构建此镜像并进行测试，可以运行以下命令：

bash
cd 10.6.4
docker build -t test/mariadb:10.6.4 .
docker run -it test/mariadb:10.6.4 bash

构建 Dockerfile

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

bash
./build-images.sh

运行此命令前需先生成 Dockerfile。在为 CircleCI 发布正式镜像时，此脚本从 CircleCI 流水线运行，而非本地。

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

上述各个脚本可用于创建镜像的正确文件，然后添加到新的 Git 分支、提交等。仓库中包含一个发布脚本以简化此过程。要为该镜像创建正式发布（以虚构的 MariaDB 版本 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。"

基础镜像 - 按照设计，当基础镜像发生变更时，不会影响现有 MariaDB 镜像。这有助于实现“确定性”并防止破坏用户构建。新的 Go 镜像将自动获取这些变更。

如果确实需要将基础镜像的变更发布到 MariaDB 镜像中，必须将特定镜像版本作为新镜像构建。这将创建新的 Dockerfile，发布后成为新镜像。

MariaDB 特定变更 - 编辑本仓库中的 Dockerfile.template 文件将专门修改 MariaDB 镜像。请注意，要在本地查看这些变更，需要重新运行 gen-dockerfiles.sh 脚本（见上文）。

贡献指南

我们鼓励通过本仓库提交 问题 和 拉取请求。

请查看我们的 贡献指南，其中概述了贡献的最佳实践以及您可以从 CircleCI 镜像团队获得的支持。

其他资源

CircleCI 文档 - *** CircleCI 文档网站。

CircleCI 配置参考 - 来自 CircleCI 文档，配置参考页面是我们最有用的页面之一。它列出了 .circleci/config.yml 中支持的所有键和值。

Docker 文档 - 对于简单项目可能不需要，但如果您想深入学*** Docker，这是一个很好的资源。

许可证

本仓库采用 MIT 许可证授权。许可证详情见 此处。