betomorrow/ci-node

ci-node Docker镜像文档

1. 镜像概述

1.1 主要用途

ci-node是一个专为GitLab CI/CD流水线设计的便捷Docker镜像，提供启用corepack的Node环境及nvm（Node Version Manager），支持灵活切换任意Node版本。集成多种开发、部署工具，简化CI/CD流程中的环境配置与云服务交互。

2. 核心功能与特性

• Node环境管理：集成nvm和corepack，支持多版本Node.js切换
• 基础工具集：包含Bash、Curl、OpenSSH、jq、zip、git、python3等常用Shell工具
• 版本控制配置：提供Git用户信息全局配置及SSH密钥集成命令
• 多云服务CLI：预装AWS CLI、Azure CLI、Google Cloud CLI，支持云服务认证与操作
• 预览部署能力：内置静态网站、Docker镜像及移动应用预览部署命令
• Dependency Track集成：支持软件物料清单（BOM）上传至Dependency Track
• 调试支持：通过环境变量启用脚本调试信息输出

3. 使用场景与适用范围

• GitLab CI/CD流水线中的Node.js项目构建、测试与部署
• 需要多版本Node.js环境切换的自动化任务
• 与AWS、Azure、GCP等云服务交互的CI/CD流程（如ECR登录、S3操作、Artifact Registry认证）
• 静态网站（SSG）、单页应用（SPA）或Docker镜像的预览环境部署
• 软件供应链安全扫描（Dependency Track BOM上传）

4. 详细使用方法与配置说明

4.1 基础环境信息

• 最新标签：v17
• 默认Shell：Bash
• 包含工具：Bash、Curl、OpenSSH、jq、zip、git、python3、AWS CLI、Google Cloud CLI

4.2 SSH配置

4.2.1 预配置

SSH客户端已预配置gitlab.com和github.com的SSH主机密钥（详见known_hosts）。

4.2.2 环境变量

4.3 Git配置

4.3.1 环境变量

4.3.2 命令

4.4 云服务CLI配置

4.4.1 Amazon Web Services (AWS) CLI

默认区域：eu-west-1

环境变量

命令

4.4.2 Azure CLI

无特定命令或环境变量。

4.4.3 Google Cloud (GCP) CLI

环境变量

4.5 预览部署

4.5.1 Web预览

命令

bash
push_web_preview <src_path|docker_tag> <app_name>

描述：部署Web预览。

• 静态网站（SSG）：指定包含index.html的目录路径；SPA需将index.html复制为_errors.html以处理路由错误。
• Docker镜像：指定镜像标签（镜像必须监听8080端口）。
  app_name为提示性名称（如backend/frontend、storybook）。

4.5.2 移动应用预览

命令

bash
push_mobile_preview <filename> <filepath> <app_name>

描述：部署移动应用预览。

• filename：下载时显示的文件名
• filepath：构建产物的系统路径
• app_name：提示性名称（如android/ios）

4.5.3 预览环境变量

4.6 Dependency Track集成

环境变量

命令

bash
dtrack-upload -g <GROUP_NAME> -p <PROJECT_NAME> -b <BOM.json>

描述：上传BOM文件至Dependency Track。

• -g：指定项目组名
• -p：指定项目名
• -b：BOM文件路径

4.7 调试配置

环境变量

5. Docker部署示例

5.1 基础运行命令

bash
docker run --rm -it ci-node:v17 bash

5.2 GitLab CI配置示例

在.gitlab-ci.yml中使用：

yaml
stages:
  - build
  - deploy

build-node-app:
  image: ci-node:v17
  stage: build
  variables:
    CIBTO_GIT_USER_NAME: "CI Bot"
    CIBTO_GIT_USER_EMAIL: "ci@example.com"
  script:
    - nvm use 18  # 切换Node版本
    - npm install
    - npm run build

deploy-preview:
  image: ci-node:v17
  stage: deploy
  variables:
    CIBTO_PREVIEWS_SERVER_URL: "https://previews.example.com"
    CIBTO_PREVIEWS_TOKEN: "$PREVIEW_TOKEN"
  script:
    - push_web_preview ./dist frontend-app

6. 环境变量参考汇总