pipe-node

概述

pipe-node是一款专为CI/CD流水线设计的Docker镜像，提供Node.js项目全流程自动化处理能力，包括NPM仓库登录、依赖安装、应用构建及自定义命令执行。支持npm、yarn、pnpm多包管理器，通过环境变量灵活配置，满足各类Node.js项目的自动化构建需求。

核心功能与特性

支持NPM仓库认证与多 registry 配置
兼容npm、yarn、pnpm三种包管理器（默认pnpm）
依赖安装缓存机制，提升构建效率
基于分支/标签的环境变量动态注入
自定义构建脚本与命令参数配置
细粒度日志级别控制（panic至trace）

使用场景

适用于各类CI/CD流程中Node.js项目的自动化处理场景：

持续集成环境中的依赖安装与版本控制
多环境（开发/测试/生产）自动化构建与部署
私有NPM仓库的依赖拉取与发布前置处理
标准化Node.js项目的流水线操作流程

使用方法

全局标志

标志/环境变量	描述	类型	是否必填	默认值
`$LOG_LEVEL`	应用日志级别	`string`，枚举值："panic"、"fatal"、"warn"、"info"、"debug"、"trace"	否	`info`
`$ENV_FILE`	待注入的环境变量文件路径列表	`string[]`	否	`[]`

命令详情

`pipe-node login`

登录到指定NPM仓库，配置认证信息。

Flags

登录配置

标志/环境变量	描述	类型	是否必填	默认值
`$NPM_LOGIN`	NPM仓库登录信息，JSON数组格式	`string`，结构：`[{"username": string, "password": string, "registry"?: string, "useHttps"?: bool}]`	否	``
`$NPM_NPMRC_FILE`	要使用的.npmrc文件路径	`string[]`	否	`[.npmrc]`
`$NPM_NPMRC`	.npmrc文件的直接内容	`string`	否	``

包管理器配置

标志/环境变量	描述	类型	是否必填	默认值
`$NODE_PACKAGE_MANAGER`	首选包管理器	`string`，枚举值："npm"、"yarn"、"pnpm"	否	`pnpm`

`pipe-node install`

使用指定包管理器安装Node.js项目依赖。

Flags

安装配置

标志/环境变量	描述	类型	是否必填	默认值
`$NODE_INSTALL_CWD`	安装工作目录	`string`	否	`.`
`$NODE_INSTALL_USE_LOCK_FILE`	是否使用锁文件安装	`bool`	否	`true`
`$NODE_INSTALL_ARGS`	安装命令附加参数	`string`	否	``
`$NODE_INSTALL_CACHE_ENABLE`	是否启用依赖缓存	`bool`	否	`true`

登录配置（同login命令）

包管理器配置（同login命令）

`pipe-node build`

执行Node.js应用构建操作。

Flags

构建配置

标志/环境变量	描述	类型	是否必填	默认值
`$NODE_BUILD_SCRIPT`	package.json中构建脚本名称	`string`，模板结构：`{Environment: string, EnvVars: map[string]string}`	否	`build`
`$NODE_BUILD_SCRIPT_ARGS`	构建脚本参数	`string`，模板结构：`{Environment: string, EnvVars: map[string]string}`	否	``
`$NODE_BUILD_CWD`	构建工作目录	`string`	否	`.`

环境配置

标志/环境变量	描述	类型	是否必填	默认值
`$ENVIRONMENT_ENABLE`	是否启用环境变量注入	`bool`	否	`false`
`$ENVIRONMENT_CONDITIONS`	环境选择正则规则，"heads/"限定分支，"tags/"限定标签	`string`，JSON数组：`[{"match": RegExp, "environment": string}]`	否	`[{"match": "^tags/v?\\d+.\\d+.\\d+$", "environment": "production"},{"match": "^tags/v?\\d+.\\d+.\\d+-.*\\.\\d+$", "environment": "stage"},{"match":"^heads/main$", "environment": "develop"},{"match": "^heads/master$", "environment": "develop"}]`
`$ENVIRONMENT_FAIL_ON_NO_REFERENCE`	环境引用缺失时是否失败	`bool`	否	`true`
`$ENVIRONMENT_STRICT`	未匹配环境时是否失败	`bool`	否	`true`

GIT配置

标志/环境变量	描述	类型	是否必填	默认值
`$CI_COMMIT_REF_NAME`/`$BITBUCKET_BRANCH`	源代码分支名	`string`	否	``
`$CI_COMMIT_TAG`/`$BITBUCKET_TAG`	源代码标签名	`string`	否	``

包管理器配置（同login命令）

`pipe-node run`

执行自定义Node.js命令。

Flags

命令配置

标志/环境变量	描述	类型	是否必填	默认值
`$NODE_COMMAND_SCRIPT`	package.json中自定义脚本名称	`string`，模板结构：`{Environment: string, EnvVars: map[string]string}`	否	``
`$NODE_COMMAND_CWD`	命令执行目录	`string`	否	`.`

环境配置（同build命令）

GIT配置（同build命令）

包管理器配置（同login命令）

部署示例

使用npm安装依赖

bash
docker run --rm \
  -e NODE_PACKAGE_MANAGER=npm \
  -e NODE_INSTALL_CACHE_ENABLE=true \
  -v $(pwd):/app \
  pipe-node install

登录私有仓库并构建生产环境

bash
docker run --rm \
  -e NPM_LOGIN='[{"username":"npmuser","password":"npmtoken","registry":"[***]"}]' \
  -e ENVIRONMENT_ENABLE=true \
  -e CI_COMMIT_TAG=v1.0.0 \
  -e NODE_BUILD_SCRIPT=build:prod \
  -v $(pwd):/app \
  pipe-node build

查看更多 pipe-node 相关镜像 →