clickhouse/upgrade-check

镜像概述

该镜像是专为CI（持续集成）环境设计的升级检查工具，旨在自动化检测系统、依赖库或组件的升级需求，并验证升级的可行性与兼容性。通过集成到CI流程中，可减少人工干预，快速识别升级风险，提升持续集成流程的稳定性和效率。

核心功能与特性

• 自动化升级检测：支持对指定目标（如依赖库、系统组件、配置文件）进行版本对比，自动识别可升级项及版本差异
• CI流程无缝集成：适配主流CI平台（Jenkins、GitLab CI、GitHub Actions等），支持通过命令行参数或配置文件自定义检查规则
• 兼容性验证：内置基础兼容性检查逻辑，可初步验证升级目标与当前环境的兼容性，降低升级风险
• 轻量级设计：镜像体积精简，启动速度快，适合CI流水线中的临时任务执行，减少资源占用
• 灵活配置：支持通过环境变量、命令行参数或挂载配置文件定义检查范围、输出格式（文本/JSON）及告警阈值

使用场景与适用范围

• 依赖库升级检查：在CI流水线中（如构建阶段前）自动检测项目依赖（npm、Maven、PyPI等）的最新版本及安全更新
• 系统组件更新验证：针对CI环境中的基础组件（如Docker引擎、数据库客户端、工具链）进行版本合规性与升级可行性检查
• 配置文件变更检测：监控关键配置文件（如.env、config.yaml）的版本变更，确保升级过程中配置一致性
• 预发布环境验证：在应用发布前，对目标环境的组件升级需求进行前置检查，避免发布后兼容性问题

使用方法与配置说明

基础使用（docker run命令）

通过以下命令启动升级检查任务：

bash
docker run --rm \
  -v /path/to/project:/workspace \  # 挂载CI项目目录（可选，用于读取本地依赖文件）
  ci-upgrade-check \
  --target <检查目标> \             # 必选，指定检查对象（如"dependencies"、"system-packages"）
  --source <检查源> \               # 可选，指定版本源（如"npm-registry"、"apt-repo"，默认自动识别）
  --output <输出格式>               # 可选，输出格式：text（默认）/json，用于CI平台解析

参数说明

环境变量配置

支持通过环境变量传递核心配置，替代命令行参数（优先级：命令行参数 > 环境变量）：

环境变量使用示例

bash
docker run --rm \
  -e CHECK_TARGET=dependencies \
  -e OUTPUT_FORMAT=json \
  -e PROJECT_PATH=/app \
  -v $(pwd):/app \  # 挂载本地项目目录到容器内/app
  ci-upgrade-check

CI平台集成示例（GitLab CI）

在.gitlab-ci.yml中添加升级检查任务：

yaml
stages:
  - pre-build
  - build

upgrade-check:
  stage: pre-build
  image: ci-upgrade-check
  script:
    - docker run --rm \
        -e CHECK_TARGET=dependencies \
        -e PROJECT_PATH=$CI_PROJECT_DIR \  # 使用GitLab CI内置环境变量指定项目路径
        -v $CI_PROJECT_DIR:/app \
        ci-upgrade-check
  artifacts:
    paths:
      - upgrade-report.txt  # 若启用文件输出，可将检查报告作为制品保留
  only:
    - merge_requests  # 仅在合并请求或主分支触发
    - main

输出说明

• 文本格式：默认输出，包含检查目标、当前版本、最新版本、升级建议及兼容性风险等级（低/中/高）
• JSON格式：结构化输出，包含target（检查目标）、current_version（当前版本）、latest_version（最新版本）、compatibility_risk（风险等级）、upgrade_suggestion（建议操作）等字段，便于CI平台通过脚本解析并触发后续流程（如自动升级或告警）