cimg/gcp

CircleCI便捷镜像 => GCP

一个专注于持续交付与部署的Docker镜像，专为在CircleCI上运行而构建

![CircleCI构建状态]([] ![CircleCI社区]([]

cimg/gcp是由CircleCI创建的Docker镜像，专为持续交付和部署流水线设计。它包含GCP CLI及相关工具，基于https://github.com/CircleCI-Public/cimg-deploy%E9%95%9C%E5%83%8F%E6%9E%84%E5%BB%BA%E3%80%82%E6%AF%8F%E4%B8%AA%E6%A0%87%E7%AD%BE%E9%83%BD%E6%98%AF%E5%9F%BA%E4%BA%8E%E6%97%A5%E6%9C%9F%E7%9A%84%E5%BF%AB%E7%85%A7%E3%80%82

目录

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

快速开始

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

yaml
jobs:
  build:
    docker:
      - image: cimg/gcp:2022.08.1
    steps:
      - checkout
      - run: echo "执行操作"

在上述示例中，CircleCI GCP Docker镜像被用作主容器。具体来说，使用了标签2022.08.1，表示这是2022年8月的第1个快照版本。现在，您可以在此作业中使用此镜像中预安装的所有工具。

镜像工作原理

此镜像每月发布一次。每个月，我们会将主要工具更新到可用的新版本。

变体

变体镜像通常包含相同的基础软件，但有一些额外的修改。

Node.js

此镜像没有node变体。它基于deploy镜像的node变体构建，这意味着Node.js已预先安装。

标签方案

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

cimg/gcp:YYYY.MM.I

标签格式为YYYY.MM.I，其中YYYY是4位年份，MM是2位月份，I是该月的第n次发布。最后一部分通常仅在需要修补当月镜像时才会更改。

开发指南

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

• Linux（已测试Ubuntu）或macOS本地机器
• 新版本的Bash（v4+）
• 新版本的Docker Engine（v20.10+）

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

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

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

如果已克隆但遗漏此步骤，可运行git submodule update --init来填充子模块。然后可选择将此仓库添加为自己仓库的上游：

bash
git remote add upstream https://github.com/CircleCI-Public/cimg-gcp.git

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

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

bash
git clone --recurse-submodules git@github.com:CircleCI-Public/cimg-gcp.git

生成Dockerfile

可使用gen-dockerfiles.sh脚本生成Dockerfile。例如，从仓库根目录运行以下命令：

bash
./shared/gen-dockerfiles.sh 2022.08.1

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

bash
cd 2022.08
docker build -t test/gcp:2022.08.1 .
docker run -it test/gcp:2022.08.1 bash

构建Dockerfile

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

bash
./build-images.sh

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

发布正式镜像（仅限维护者）

上述各个脚本可用于创建镜像的正确文件，然后添加到新的git分支、提交等。发布脚本可简化此过程。要为此镜像创建正式发布（以假设日期1991年4月为例），从仓库根目录运行以下命令：

bash
./shared/release.sh 1991.04.2

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

• 等待CircleCI上的构建通过
• 审核PR
• 合并PR

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

变更合并

变更如何合并到此镜像取决于其来源：

构建脚本 - ./shared子模块内的变更在其https://github.com/CircleCI-Public/cimg-shared%E4%B8%AD%E8%BF%9B%E8%A1%8C%E3%80%82%E8%A6%81%E4%BD%BF%E8%BF%99%E4%BA%9B%E5%8F%98%E6%9B%B4%E5%BD%B1%E5%93%8D%E6%AD%A4%E9%95%9C%E5%83%8F%EF%BC%8C%E9%9C%80%E6%9B%B4%E6%96%B0%E5%AD%90%E6%A8%A1%E5%9D%97%E3%80%82%E9%80%9A%E5%B8%B8%E6%93%8D%E4%BD%9C%E5%A6%82%E4%B8%8B%EF%BC%9A

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

父镜像 - 设计上，父镜像发生变更时不会影响现有GCP镜像。这有助于确保“确定性”并防止破坏客户构建。新的GCP镜像将自动获取变更。

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

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

贡献指南

我们鼓励针对此仓库提交https://github.com/CircleCI-Public/cimg-gcp/issues%E5%92%8Chttps://github.com/CircleCI-Public/cimg-gcp/pulls%E3%80%82%E4%B8%BA%E8%8A%82%E7%9C%81%E6%82%A8%E7%9A%84%E6%97%B6%E9%97%B4%EF%BC%8C%E8%AF%B7%E6%B3%A8%E6%84%8F%E4%BB%A5%E4%B8%8B%E4%BA%8B%E9%A1%B9%EF%BC%9A

1. 并非所有内容都可添加到此镜像。要在GCP镜像中添加工具，该工具必须是受维护的，且对大量CircleCI用户有用。添加的每个工具都会增大镜像体积并降低所有用户的速度，因此严格把控镜像内容对所有人都有益。
2. 欢迎PR。如果您的PR可能需要大量时间，请先打开issue讨论，以确保值得投入时间。
3. Issue应用于报告bug或请求在此镜像中添加/删除工具。有关镜像使用帮助，请访问CircleCI Discuss。

其他资源

CircleCI文档 - 官方CircleCI文档网站。 CircleCI配置参考 - CircleCI文档中的配置参考页面是最有用的页面之一，列出了.circleci/config.yml支持的所有键和值。 Docker文档 - 对于简单项目可能不需要，但如需深入学习Docker，这是很好的资源。

许可证

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