lsage/pnpm-circleci-node

lsage/pnpm-circleci-node

镜像概述

lsage/pnpm-circleci-node是一个专为CircleCI构建环境设计的Docker镜像，预安装了pnpm包管理器。该镜像旨在简化使用pnpm的Node.js项目在CircleCI平台上的构建流程，提供开箱即用的依赖管理能力，减少CI配置中的依赖安装步骤。

核心功能与特性

• 预安装pnpm：无需在CI配置中额外安装pnpm，可直接使用pnpm install、pnpm run等命令管理项目依赖和执行脚本
• CircleCI兼容：针对CircleCI构建环境优化，可直接作为CircleCI作业的执行容器
• Node.js环境：基于Node.js基础镜像构建，支持标准Node.js项目开发和构建流程
• 依赖管理效率：利用pnpm的高效依赖安装机制（如硬链接、共享依赖存储），加速CI环境中的依赖安装过程

使用场景与适用范围

• 使用pnpm作为包管理器的Node.js项目在CircleCI上的持续集成/持续部署（CI/CD）流程
• 需要在CircleCI中执行依赖安装、测试、构建等任务的前端或Node.js后端项目
• 希望简化CI配置，减少依赖安装步骤的开发团队

使用方法与配置说明

基本使用（Docker Run）

可通过以下命令直接运行该镜像：

bash
docker run --rm -it lsage/pnpm-circleci-node pnpm --version

在CircleCI配置中使用

在CircleCI的.circleci/config.yml文件中，可将该镜像指定为作业的执行容器：

yaml
version: 2.1

jobs:
  build:
    docker:
      - image: lsage/pnpm-circleci-node
    steps:
      - checkout
      - run: pnpm install  # 直接使用pnpm安装依赖
      - run: pnpm run test  # 执行测试脚本
      - run: pnpm run build  # 执行构建脚本

环境变量

该镜像继承自Node.js基础镜像，支持Node.js相关的标准环境变量，例如：

• NODE_ENV：指定Node.js环境（如production、development）
• NPM_CONFIG_*：npm配置相关环境变量（pnpm兼容部分npm配置）

注意事项

• 确保项目中已包含pnpm-lock.yaml文件，以保证依赖版本一致性
• 根据项目需求，可在CircleCI配置中进一步指定Node.js版本（需确认镜像标签是否支持对应版本）
• 对于大型项目，可结合CircleCI的缓存机制缓存node_modules目录，进一步提升构建效率