Continuous Integration

pnpm can easily be used in various continuous integration systems.

Travis

On Travis CI, you can use pnpm for installing your dependencies by adding this to your .travis.yml file:

.travis.yml

  1. cache:
  2.   npm: false
  3.   directories:
  4.     - "~/.pnpm-store"
  5. before_install:
  6.   - corepack enable
  7.   - corepack prepare pnpm@latest-7 --activate
  8.   - pnpm config set store-dir ~/.pnpm-store
  9. install:
  10.   - pnpm install

Semaphore

On Semaphore, you can use pnpm for installing and caching your dependencies by adding this to your .semaphore/semaphore.yml file:

.semaphore/semaphore.yml

  1. version: v1.0
  2. name: Semaphore CI pnpm example
  3. agent:
  4.   machine:
  5.     type: e1-standard-2
  6.     os_image: ubuntu1804
  7. blocks:
  8.   - name: Install dependencies
  9.     task:
  10.       jobs:
  11.         - name: pnpm install
  12.           commands:
  13.             - corepack enable
  14.             - corepack prepare pnpm@latest-7 --activate
  15.             - checkout
  16.             - cache restore node-$(checksum pnpm-lock.yaml)
  17.             - pnpm install
  18.             - cache store node-$(checksum pnpm-lock.yaml) $(pnpm store path)

AppVeyor

On AppVeyor, you can use pnpm for installing your dependencies by adding this to your appveyor.yml:

appveyor.yml

  1. install:
  2.   - ps: Install-Product node $env:nodejs_version
  3.   - corepack enable
  4.   - corepack prepare pnpm@latest-7 --activate
  5.   - pnpm install

GitHub Actions

On GitHub Actions, you can use pnpm for installing and caching your dependencies like so (belongs in .github/workflows/NAME.yml):

.github/workflows/NAME.yml

  1. name: pnpm Example Workflow
  2. on:
  3.   push:
  4. jobs:
  5.   build:
  6.     runs-on: ubuntu-20.04
  7.     strategy:
  8.       matrix:
  9.         node-version: [15]
  10.     steps:
  11.     - uses: actions/checkout@v3
  12.     - uses: pnpm/action-setup@v2
  13.       with:
  14.         version: 7
  15.     - name: Use Node.js ${{ matrix.node-version }}
  16.       uses: actions/setup-node@v3
  17.       with:
  18.         node-version: ${{ matrix.node-version }}
  19.         cache: 'pnpm'
  20.     - name: Install dependencies
  21.       run: pnpm install

Continuous Integration - 图1note

Caching packages dependencies with actions/setup-node@v2 requires you to install pnpm with version 6.10+.

GitLab CI

On GitLab, you can use pnpm for installing and caching your dependencies like so (belongs in .gitlab-ci.yml):

.gitlab-ci.yml

  1. stages:
  2.   - build
  4. build:
  5.   stage: build
  6.   image: node:14.16.0-buster
  7.   before_script:
  8.     - corepack enable
  9.     - corepack prepare pnpm@latest-7 --activate
  10.     - pnpm config set store-dir .pnpm-store
  11.   script:
  12.     - pnpm install # install dependencies
  13.   cache:
  14.     key:
  15.       files:
  16.         - pnpm-lock.yaml
  17.     paths:
  18.       - .pnpm-store

Bitbucket Pipelines

You can use pnpm for installing and caching your dependencies:

.bitbucket-pipelines.yml

  1. definitions:
  2.   caches:
  3.     pnpm: $BITBUCKET_CLONE_DIR/.pnpm-store
  5. pipelines:
  6.   pull-requests:
  7.     "**":
  8.       - step:
  9.           name: Build and test
  10.           image: node:14.16.0
  11.           script:
  12.             - corepack enable
  13.             - corepack prepare pnpm@latest-7 --activate
  14.             - pnpm install
  15.             - pnpm run build # Replace with your build/test…etc. commands
  16.           caches:
  17.             - pnpm

Azure Pipelines

On Azure Pipelines, you can use pnpm for installing and caching your dependencies by adding this to your azure-pipelines.yml:

azure-pipelines.yml

  1. variables:
  2.   pnpm_config_cache: $(Pipeline.Workspace)/.pnpm-store
  4. steps:
  5.   - task: Cache@2
  6.     inputs:
  7.       key: 'pnpm | "$(Agent.OS)" | pnpm-lock.yaml'
  8.       path: $(pnpm_config_cache)
  9.     displayName: Cache pnpm
  11.   - script: |
  12.       corepack enable
  13.       corepack prepare pnpm@latest-7 --activate
  14.       pnpm config set store-dir $(pnpm_config_cache)
  15.     displayName: "Setup pnpm"
  17.   - script: |
  18.       pnpm install
  19.       pnpm run build
  20.     displayName: "pnpm install and build"

CircleCI

On CircleCI, you can use pnpm for installing and caching your dependencies by adding this to your .circleci/config.yml:

.circleci/config.yml

  1. version: 2.1
  3. jobs:
  4.   build: # this can be any name you choose
  5.     docker:
  6.       - image: node:18
  7.     resource_class: large
  8.     parallelism: 10
  10.     steps:
  11.       - checkout
  12.       - restore_cache:
  13.           name: Restore pnpm Package Cache
  14.           keys:
  15.             - pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
  16.       - run:
  17.           name: Install pnpm package manager
  18.           command: |
  19.             corepack enable
  20.             corepack prepare pnpm@latest-7 --activate
  21.       - run:
  22.           name: Install Dependencies
  23.           command: |
  24.             pnpm install
  25.       - save_cache:
  26.           name: Save pnpm Package Cache
  27.           key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
  28.           paths:
  29.             - node_modules

Jenkins

You can use pnpm for installing and caching your dependencies:

  1. pipeline {
  2.     agent {
  3.         docker {
  4.             image 'node:lts-bullseye-slim' 
  5.             args '-p 3000:3000' 
  6.         }
  7.     }
  8.     stages {
  9.         stage('Build') { 
  10.             steps {
  11.                 sh 'corepack enable'
  12.                 sh 'corepack prepare pnpm@latest-7 --activate'
  13.                 sh 'pnpm install'
  14.             }
  15.         }
  16.     }
  17. }