altmetric/ci

Altmetric CI 镜像文档

镜像概述

Altmetric CI镜像是Altmetric项目的官方持续集成(CI)环境镜像，旨在为开发团队提供标准化、一致性的持续集成环境。该镜像预配置了项目所需的依赖工具链、运行时环境及CI流程必需组件，支持自动化构建验证、代码测试和部署前置检查，有效简化开发团队的CI流程配置，降低环境差异导致的集成问题。

核心功能与特性

环境一致性保障

• 预安装Altmetric项目开发流程中所需的核心依赖（如特定版本的Python、Node.js、Docker CLI等），确保不同开发/CI环境中依赖版本统一。
• 基于轻量级基础镜像（Alpine/Ubuntu Slim）构建，平衡功能完整性与资源占用，缩短CI任务启动时间。

CI流程集成能力

• 兼容主流CI平台（GitHub Actions、GitLab CI、Jenkins等），支持标准CI/CD流程配置文件（如.github/workflows/*.yml、.gitlab-ci.yml）。
• 内置CI任务执行框架，可直接运行项目定义的测试脚本（如pytest、npm test）及构建命令（如make build）。

开发效率优化

• 支持本地开发环境模拟CI流程，通过容器化方式复现CI环境，减少"本地运行正常，CI失败"的环境差异问题。
• 集成日志收集与报告生成工具，CI任务结果可通过标准输出或文件形式导出，便于问题定位。

使用场景与适用范围

典型使用场景

• 代码提交验证：开发人员提交代码后，CI系统自动拉取该镜像，运行项目测试套件，验证代码正确性。
• 构建流程标准化：在部署前通过镜像执行统一的构建命令（如生成Docker镜像、打包应用资产），确保构建产物一致性。
• 本地CI调试：开发人员本地运行镜像模拟CI流程，提前发现环境依赖或脚本问题，减少CI流程反复调试成本。

适用范围

• Altmetric项目开发团队的日常持续集成流程。
• 需要复现CI环境的本地开发与问题排查场景。
• 第三方扩展开发中对Altmetric项目CI流程的适配测试。

使用方法与配置说明

基础使用（Docker Run）

通过docker run命令直接启动CI任务，基本语法如下：

bash
docker run --rm \
  -v $(pwd):/app \  # 挂载本地项目目录至容器内工作区
  -e CI_PROJECT_DIR=/app \  # 指定项目根目录
  -e CI_COMMIT_SHA=$(git rev-parse HEAD) \  # 传入当前提交SHA
  altmetric/ci:latest \
  sh -c "cd /app && ./scripts/ci/run-tests.sh"  # 执行CI任务命令

参数说明

Docker Compose 配置示例

对于复杂CI流程（如依赖外部服务如数据库），可通过docker-compose.yml定义多容器环境：

yaml
version: '3.8'
services:
  ci:
    image: docker.xuanyuan.run/altmetric/ci:latest
    volumes:
      - ./:/app
    environment:
      - CI_PROJECT_DIR=/app
      - CI_COMMIT_SHA=${CI_COMMIT_SHA:-latest}
      - CI_DEBUG=true
      - DB_HOST=db
      - DB_PORT=5432
    depends_on:
      - db
    command: sh -c "cd /app && ./scripts/ci/run-integration-tests.sh"
  
  db:
    image: docker.xuanyuan.run/postgres:14-alpine
    environment:
      - POSTGRES_USER=ci_test
      - POSTGRES_PASSWORD=ci_test_pass
      - POSTGRES_DB=ci_test_db

启动命令：

bash
CI_COMMIT_SHA=$(git rev-parse HEAD) docker-compose up --build

注意事项

• 镜像标签策略：使用latest获取最新稳定版，生产环境建议指定具体版本标签（如v1.2.0）以确保环境稳定性。
• 本地调试：通过-it参数进入容器交互模式，手动执行命令排查问题：
  docker run --rm -it -v $(pwd):/app altmetric/ci:latest sh
• 依赖更新：镜像依赖工具链版本会随项目需求更新，使用前建议查阅https://github.com/altmetric/ci-image/releases%E7%A1%AE%E8%AE%A4%E5%85%BC%E5%AE%B9%E6%80%A7%E3%80%82