plugins/npm

drone-npm

![构建状态]([]
![镜像信息]([]
![参与讨论]([]
![问题咨询]([]

镜像概述和主要用途

概述

drone-npm 是 Drone CI/CD 平台的官方插件，用于在自动化流水线中集成 npm 包管理工具的相关操作。该插件由 https://github.com/drone-plugins/drone-npm 项目维护，通过 Drone CI 构建并推送至镜像仓库，提供标准化的 npm 命令执行环境。

主要用途

作为 Drone 流水线的组件，drone-npm 主要用于在 CI/CD 流程中自动化执行 npm 相关任务，包括但不限于：

• 安装项目依赖（npm install）
• 运行测试脚本（npm test）
• 执行构建命令（如 npm run build）
• 发布 npm 包（npm publish，需配置认证信息）

核心功能和特性

1. 原生 npm 命令支持
   直接集成 npm 工具链，支持执行任意 npm 命令（如 install、test、run <script> 等），兼容标准 npm 脚本语法。

2. Drone 环境集成
   自动读取 Drone 流水线上下文信息（如环境变量、工作目录），无需额外配置即可适配流水线环境。

3. 灵活的参数配置
   支持自定义命令参数、工作目录、npm 镜像源（registry）及认证信息，满足私有仓库或特殊环境需求。

4. 轻量级镜像
   基于官方 Node.js 基础镜像构建，精简依赖，减少流水线执行时间和资源占用。

使用场景和适用范围

适用场景

• 前端项目自动化构建：在 React、Vue 等前端项目的 Drone 流水线中，通过 npm install 安装依赖后执行 npm run build 生成静态资源。
• 代码质量检测：配合 npm test 执行单元测试、E2E 测试或代码 lint（如 ESLint），确保代码质量。
• npm 包发布：在版本更新时，通过 npm publish 自动发布包至 npm 仓库（需配置 NPM_TOKEN 等认证信息）。

适用范围

• 基于 npm 管理依赖的 JavaScript/TypeScript 项目（Node.js 后端、前端应用等）。
• 使用 Drone CI/CD 作为自动化平台的团队或个人项目。

使用方法和配置说明

前置条件

• 已部署 Drone CI/CD 平台，且流水线已正确配置代码仓库（如 GitHub、GitLab）。
• 项目根目录下存在 package.json 文件（定义 npm 脚本和依赖）。

基本使用方式

drone-npm 作为 Drone 插件，需在流水线配置文件（通常为 .drone.yml）中定义步骤，通过 image: plugins/npm 指定镜像，并配置 settings 字段定义具体行为。

示例 1：安装依赖并运行测试

在流水线中执行 npm install 安装依赖，随后通过 npm test 运行测试脚本：

yaml
kind: pipeline
type: docker
name: default

steps:
  - name: npm-test
    image: plugins/npm
    settings:
      command: test  # 等效于执行 `npm test`
      # 可选：指定 npm 镜像源（如使用淘宝镜像加速国内访问）
      registry: https://registry.npm.taobao.org

示例 2：执行自定义构建命令

运行项目自定义脚本（如 npm run build）生成构建产物：

yaml
steps:
  - name: npm-build
    image: plugins/npm
    settings:
      command: run build  # 等效于执行 `npm run build`
      # 可选：指定工作目录（默认为流水线工作目录）
      working_dir: ./frontend

示例 3：发布 npm 包至私有仓库

配置认证信息，发布包至私有 npm 仓库（需提前在 Drone 中配置 secrets，如 npm_token）：

yaml
steps:
  - name: npm-publish
    image: plugins/npm
    settings:
      command: publish  # 执行 `npm publish`
      registry: https://npm.example.com  # 私有仓库地址
      token:
        from_secret: npm_token  # 从 Drone secrets 读取认证 token

配置参数说明

完整 .drone.yml 示例

yaml
kind: pipeline
type: docker
name: frontend-ci

steps:
  - name: install-deps
    image: plugins/npm
    settings:
      command: install
      registry: https://registry.npm.taobao.org  # 使用淘宝镜像加速

  - name: run-tests
    image: plugins/npm
    settings:
      command: test
      args: -- --coverage  # 传递参数给测试命令（如生成覆盖率报告）

  - name: build
    image: plugins/npm
    settings:
      command: run build
      working_dir: ./src  # 假设构建脚本在 src 目录下

  - name: publish-package
    image: plugins/npm
    settings:
      command: publish
      registry: https://npm.example.com  # 私有仓库
      token:
        from_secret: npm_private_token  # 从 Drone secrets 读取 token
    when:
      event: tag  # 仅在标签推送时执行发布

注意事项

• 版本指定：建议在 image 字段中指定具体版本（如 plugins/npm:1.2.0），避免因镜像更新导致兼容性问题。
• 认证安全：涉及 token、password 等敏感信息时，必须通过 Drone Secrets 管理，禁止明文写入配置文件。
• 命令调试：若命令执行失败，可在 args 中添加 --verbose（如 args: --verbose）查看 npm 详细日志，辅助定位问题。

项目维护地址：https://github.com/drone-plugins/drone-npm
问题反馈：Drone Discourse 或 StackOverflow（drone.io 标签）