跳到主要内容
pnpm
文档目录

持续集成

查看英文原文 ↗

pnpm 可以轻松地用于各种持续集成系统。

安装 pnpm

除 GitHub Actions（它有自己的 action）之外，使用独立脚本安装 pnpm：

curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -

有两点让这在 CI 中很方便：

  • 不需要 Node.js。 pnpm 是自包含的可执行文件，之后可以用 pnpm runtime set node lts -g 为你安装运行时，因此任务一开始并不需要 Node.js 镜像。
  • 跟随项目的版本。 引导过程安装最新的 pnpm 12，随后如果你的 package.json 中有 packageManager 或 devEngines.packageManager 字段，pnpm 会在首次使用时切换到该版本，因此流水线不必在两处锁定版本。

脚本安装到 PNPM_HOME 并向 shell 配置文件追加内容，而 CI 任务从不重新加载这些配置。你需要自行声明 PNPM_HOME 并把 $PNPM_HOME/bin 加入 PATH，使用平台提供的任意机制即可，下面的示例对每个平台都做了演示。

AppVeyor

在 AppVeyor 上，把以下内容加入你的 appveyor.yml 即可使用 pnpm 安装依赖：

appveyor.yml

environment:
  PNPM_HOME: C:\pnpm

install:
  - ps: $env:PATH = "$env:PNPM_HOME;$env:PNPM_HOME\bin;$env:PATH"
  - ps: $env:PNPM_VERSION = "latest-12"; Invoke-WebRequest https://get.pnpm.io/install.ps1 -UseBasicParsing | Invoke-Expression
  - ps: pnpm install

pnpm 自带运行时，因此不再需要 Install-Product node。如果你的构建脚本直接调用 node，添加 pnpm runtime set node lts -g。

Azure Pipelines

在 Azure Pipelines 上，把以下内容加入你的 azure-pipelines.yml 即可使用 pnpm 安装并缓存依赖：

azure-pipelines.yml

variables:
  pnpm_config_cache: $(Pipeline.Workspace)/.pnpm-store
  PNPM_HOME: $(Pipeline.Workspace)/.pnpm

steps:
  - task: Cache@2
    inputs:
      key: 'pnpm | "$(Agent.OS)" | pnpm-lock.yaml'
      path: $(pnpm_config_cache)
    displayName: Cache pnpm

  - script: |
      curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
      echo "##vso[task.prependpath]$(PNPM_HOME)/bin"
      "$(PNPM_HOME)/bin/pnpm" config set store-dir $(pnpm_config_cache)
    displayName: "Setup pnpm"

  - script: |
      pnpm install
      pnpm run build
    displayName: "pnpm install and build"

task.prependpath 会将 pnpm 加入 PATH 供后续步骤使用；在执行安装的那个步骤内，需用完整路径调用它。

Bitbucket Pipelines

你可以使用 pnpm 安装并缓存依赖：

.bitbucket-pipelines.yml

definitions:
  caches:
    pnpm: $BITBUCKET_CLONE_DIR/.pnpm-store

pipelines:
  pull-requests:
    "**":
      - step:
          name: Build and test
          image: debian:stable-slim
          script:
            - apt-get update && apt-get install -y --no-install-recommends ca-certificates curl
            - export PNPM_HOME="$HOME/.local/share/pnpm"
            - export PATH="$PNPM_HOME/bin:$PATH"
            - curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
            - pnpm config set store-dir "$BITBUCKET_CLONE_DIR/.pnpm-store"
            - pnpm runtime set node lts -g
            - pnpm install
            - pnpm run build # Replace with your build/test…etc. commands
          caches:
            - pnpm

一个步骤中的所有行在同一个 shell 中运行，因此 export 会延续到后面的行，store-dir 也指向缓存保存的目录。

该示例从纯净镜像开始，让 pnpm 安装 Node.js。如果你不想更换，可以保留现有的 node 镜像并去掉 pnpm runtime set 这一行。

CircleCI

在 CircleCI 上，把以下内容加入你的 .circleci/config.yml 即可使用 pnpm 安装并缓存依赖：

.circleci/config.yml

version: 2.1

jobs:
  build: # this can be any name you choose
    docker:
      - image: node:24
    resource_class: large
    parallelism: 10
    environment:
      PNPM_HOME: /root/.local/share/pnpm

    steps:
      - checkout
      - restore_cache:
          name: Restore pnpm Package Cache
          keys:
            - pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
      - run:
          name: Install pnpm package manager
          command: |
            curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
            echo 'export PATH="$PNPM_HOME/bin:$PATH"' >> "$BASH_ENV"
            "$PNPM_HOME/bin/pnpm" config set store-dir .pnpm-store
      - run:
          name: Install Dependencies
          command: |
            pnpm install
      - save_cache:
          name: Save pnpm Package Cache
          key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
          paths:
            - .pnpm-store

CircleCI 在每个步骤前都会加载 $BASH_ENV，pnpm 由此对后续步骤生效。

GitHub Actions

在 GitHub Actions 上，可以按如下方式使用 pnpm 安装并缓存依赖（写入 .github/workflows/NAME.yml）：

.github/workflows/NAME.yml

name: pnpm Example Workflow
on:
  push:

jobs:
  build:
    runs-on: ubuntu-24.04
    strategy:
      matrix:
        node-version: [24]
    steps:
      - uses: actions/checkout@v6
      - name: Install pnpm and Node.js
        uses: pnpm/setup@c9883cc79df532ad1a7b81bf9ab944ceb090d65c # v2.0.0
        with:
          runtime: node@${{ matrix.node-version }}
          cache: true

pnpm/setup 会安装 pnpm，然后用它安装所请求的运行时，因此不需要单独的 actions/setup-node 步骤。它还会为你运行 pnpm install，cache: true 会在多次运行之间缓存 pnpm 存储。如果你更想自己执行安装，设为 install: false。

pnpm 版本来自你的 package.json 中的 packageManager 或 devEngines.packageManager 字段，因此修改版本后工作流无需更新。如果你的 package.json 两者都没有，添加一个 version 输入。

GitLab CI

在 GitLab 上，可以按如下方式使用 pnpm 安装并缓存依赖（写入 .gitlab-ci.yml）：

.gitlab-ci.yml

stages:
  - build

build:
  stage: build
  image: node:24.14.1
  variables:
    PNPM_HOME: "$CI_PROJECT_DIR/.pnpm"
  before_script:
    - export PATH="$PNPM_HOME/bin:$PATH"
    - curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
    - pnpm config set store-dir .pnpm-store
  script:
    - pnpm install # install dependencies
  cache:
    key:
      files:
        - pnpm-lock.yaml
    paths:
      - .pnpm-store

Jenkins

你可以使用 pnpm 安装并缓存依赖：

pipeline {
    agent {
        docker {
            image 'node:lts-bookworm-slim'
            args '-p 3000:3000'
        }
    }
    environment {
        PNPM_HOME = "${WORKSPACE}/.pnpm"
        PATH = "${PNPM_HOME}/bin:${PATH}"
    }
    stages {
        stage('Build') {
            steps {
                sh 'curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -'
                sh 'pnpm install'
            }
        }
    }
}

每个 sh 步骤都在独立的 shell 中运行，因此 PATH 在流水线的 environment 块中设置，而不是在步骤内部 export。

Semaphore

在 Semaphore 上，把以下内容加入你的 .semaphore/semaphore.yml 文件即可使用 pnpm 安装并缓存依赖：

.semaphore/semaphore.yml

version: v1.0
name: Semaphore CI pnpm example
agent:
  machine:
    type: e1-standard-2
    os_image: ubuntu2404
blocks:
  - name: Install dependencies
    task:
      env_vars:
        - name: PNPM_HOME
          value: /home/semaphore/.local/share/pnpm
      jobs:
        - name: pnpm install
          commands:
            - export PATH="$PNPM_HOME/bin:$PATH"
            - curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
            - checkout
            - cache restore node-$(checksum pnpm-lock.yaml)
            - pnpm install
            - cache store node-$(checksum pnpm-lock.yaml) $(pnpm store path)

Travis

在 Travis CI 上，把以下内容加入你的 .travis.yml 文件即可使用 pnpm 安装依赖：

.travis.yml

cache:
  npm: false
  directories:
    - "~/.pnpm-store"
env:
  global:
    - PNPM_HOME="$HOME/.local/share/pnpm"
    - PATH="$PNPM_HOME/bin:$PATH"
before_install:
  - curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=latest-12 sh -
  - pnpm config set store-dir ~/.pnpm-store
install:
  - pnpm install

本页内容译自pnpm 官方文档（MIT License），如有出入以英文原文为准。