onestic/docker-ci

Docker CI

概述

onestic/docker-ci镜像旨在跨项目实现一致的代码检查、构建和推送Docker镜像（及其README文件）。

该镜像针对Bitbucket Pipelines无缝集成进行了优化，确保可靠且标准化的Docker镜像管理流程。

支持的平台和标签

此镜像构建适用于linux/amd64和linux/arm64平台。

唯一支持的镜像标签基于其依赖的Docker主版本：25-cli。该标签每日更新，可能会添加新功能（始终保持向后兼容，必要时通过功能标志激活）。

注意：可能存在其他开发相关标签，使用时需自行承担风险。

特性摘要

• 继承特性：包含最新https://hub.docker.com/_/docker/tags?page=1&name=25-cli%E7%9A%84%E6%89%80%E6%9C%89%E5%8A%9F%E8%83%BD%E3%80%82
• 持续更新：每日基于最新的Docker 25 CLI基础镜像构建。
• 代码检查：提供代码检查能力，确保Dockerfile符合最佳实践和标准。
• 自动仓库登录：容器启动时可通过预定义环境变量自动登录容器仓库。
• 多平台构建：使用https://github.com/docker/buildx%E5%92%8CQEMU%E6%A8%A1%E6%8B%9F%E5%99%A8%E5%88%9B%E5%BB%BA%E5%A4%9A%E5%B9%B3%E5%8F%B0%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%94%AF%E6%8C%81%E9%80%9A%E8%BF%87%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E9%85%8D%E7%BD%AE%E3%80%82
• 镜像推送：简化Docker镜像推送到容器仓库的流程。
• README推送：将README-containers.md / README.md文件推送到指定容器仓库，保持镜像描述和参考文档更新。
• Bitbucket管道：类似GitHub Actions，可作为Bitbucket管道使用，跨项目以一致方式执行一系列操作（代码检查 => 多平台构建 => 镜像标记 => 推送）。
• 可自定义：操作和行为等可通过环境变量配置（参见十二因素应用 - III. 配置）。

行为

当使用参数启动时，基于此镜像的容器将表现为常规docker:25-cli容器。虽然可以这样运行，但与基础镜像相比无额外优势。

该镜像的预期使用方式是不带参数，通过环境变量配置（管道模式）。在此模式下，将尝试执行以下操作：

1. 代码检查：使用https://github.com/hadolint/hadolint%E6%A3%80%E6%9F%A5Dockerfile%E4%B8%AD%E7%9A%84%E9%94%99%E8%AF%AF/%E4%B8%8D%E8%89%AF%E5%AE%9E%E8%B7%B5%E3%80%82Hadolint%E9%85%8D%E7%BD%AE%E5%86%85%E7%BD%AE%EF%BC%8C%E7%A1%AE%E4%BF%9D%E5%AF%B9%E6%89%80%E6%9C%89Dockerfile%E5%BA%94%E7%94%A8%E4%B8%80%E8%87%B4%E7%9A%84%E6%A3%80%E6%9F%A5%E8%A7%84%E5%88%99%E3%80%82
2. 仓库登录：使用指定凭据登录到Docker/容器仓库，用于拉取/推送镜像。
3. 多平台构建：构建多平台镜像，可选推送，并基于可用的版本控制系统（VCS）/CI信息以一致方式标记（即将支持自动https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys%EF%BC%8C%E5%8F%A6%E8%A7%81%E6%AD%A4%E9%93%BE%E6%8E%A5%EF%BC%89%E3%80%82
4. 推送README到仓库：尝试将README-containers.md / README.md文件推送到指定容器仓库，以保持镜像描述和参考文档更新。

使用方法

Bitbucket - 管道模式

在Bitbucket管道中作为管道使用的示例（移除不需要的注释行）：

yaml
pipelines:
  default:
    - step:
        name: '代码检查、构建与推送'
        script:
          - pipe: 'docker://onestic/docker-ci:25-cli'
            variables:
              # 取消注释以下行可跳过管道操作
              # DOCKER_CI_LINT_SKIP: '1'
              # DOCKER_CI_LOGIN_SKIP: '1'
              # DOCKER_CI_BUILD_SKIP: '1'
              # DOCKER_CI_PUSHRM_SKIP: '1'
              # 取消注释并调整以下行以指定非默认工作目录（通常不需要）
              # DOCKER_CI_WORKDIR: ${BITBUCKET_CLONE_DIR}
              # 取消注释并调整以下行以指定自定义Dockerfile路径（仅当Dockerfile不在仓库根目录时需要）
              # DOCKER_CI_DOCKERFILE: ${BITBUCKET_CLONE_DIR}/Dockerfile
              # 取消注释以下行以增加shell详细程度（-x）
              # DOCKER_CI_DEBUG: '1'
              # 取消注释并调整以下行以登录到非Docker Hub的仓库
              # DOCKER_CI_LOGIN_REGISTRY: docker.io
              # 在Bitbucket系统中以安全变量形式声明并设置登录值
              DOCKER_CI_LOGIN_REGISTRY_USER: ${DOCKER_CI_LOGIN_REGISTRY_USER}
              DOCKER_CI_LOGIN_REGISTRY_PASSWORD: ${DOCKER_CI_LOGIN_REGISTRY_PASSWORD}
              # 取消注释并调整以下行以将镜像标记/推送到非Docker Hub的仓库
              # DOCKER_CI_BUILD_IMAGE_REGISTRY: docker.io
              # 取消注释并调整以下行以指定非onestic的仓库用户
              # DOCKER_CI_BUILD_IMAGE_USER: 'onestic'
              # 取消注释并调整以下行以指定非仓库slug的仓库名称
              # DOCKER_CI_BUILD_IMAGE_REPOSITORY: ${BITBUCKET_REPO_SLUG}
              # 取消注释并调整以下行以指定非默认的构建平台
              # DOCKER_CI_BUILD_PLATFORM_EMULATORS: 'linux/amd64,linux/arm64'
              # 如果构建上下文为仓库根目录而非上下文文件夹，取消注释以下行
              # DOCKER_CI_BUILD_CONTEXT: ${BITBUCKET_CLONE_DIR}
              # 取消注释以下行以指定Dockerfile构建参数（如有需要）
              # DOCKER_CI_BUILD_ARGS: ''
              # 取消注释并调整以下行以微调`docker buildx build`命令参数
              # DOCKER_CI_BUILD_COMMAND_ARGS: '--push'
              # 使用以下行指定额外的镜像标签（在目标仓库、用户和仓库内）
              # DOCKER_CI_BUILD_TAGS: ''
              # 以下行用于自动标记
              # 可覆盖或故意设为空以跳过某些类型的自动标签
              # DOCKER_CI_BUILD_NUMBER: ''
              # DOCKER_CI_BUILD_TAG: ''
              # DOCKER_CI_BUILD_PR_ID: ''
              # DOCKER_CI_BUILD_BRANCH: ''

手动/一次性模式

可在一次性模式下运行此镜像（例如用于代码检查），需正确定义操作变量、挂载卷并指定工作目录。

例如，进入包含Dockerfile的项目目录后，可通过以下方式检查Dockerfile：

shell
docker run --rm -it \
  -e DOCKER_CI_LOGIN_SKIP=1 \
  -e DOCKER_CI_BUILD_SKIP=1 \
  -e DOCKER_CI_PUSHRM_SKIP=1 \
  -w /opt/project \
  -v "$(pwd):/opt/project" \
  -- \
  onestic/docker-ci:25-cli 

上述命令将：

• 指示容器跳过登录和构建步骤，仅执行代码检查
• 准备工作目录并挂载所需数据（Dockerfile位于根目录，因变量默认值生效）

按照上述示例，可手动/本地以一次性模式执行任意组合的管道操作。

变量参考

禁用特定管道操作

每个管道操作可通过将其对应的skip环境变量设为1来跳过：

配置管道操作

通用变量

操作：Dockerfile代码检查

注意：当操作未被跳过时，必填变量才为必填。

操作：仓库登录

注意：当操作未被跳过时，必填变量才为必填。

操作：构建/推送

注意：当操作未被跳过时，必填变量才为必填。

下表为操作特定变量：

操作：推送README

注意：当操作未被跳过时，必填变量才为必填。

另请注意：向Docker Hub推送超过25k字符的README文件可能失败。

下表为操作特定变量：