Repository files navigation

⚠️ Upgrade from v2!

The v2 version of this actionhas stopped working with newer Node.js versions. Please, upgrade to the latest version to fix any issues.

Install pnpm package manager.

Version of pnpm to install.

Optional when there is apackageManager field in thepackage.json.

otherwise, this field isrequired It supports npm versioning scheme, it could be an exact version (such as6.24.1), or a version range (such as6,6.x.x,6.24.x,^6.24.1,*, etc.), orlatest.

Optional Where to store pnpm files.

Optional (default:null) If specified, runpnpm install.

Ifrun_install is eithernull orfalse, pnpm will not install any npm package.

Ifrun_install istrue, pnpm will install dependencies recursively.

Ifrun_install is a YAML string representation of either an object or an array, pnpm will execute every install commands.

Optional (type:boolean,default:false) Whether to usepnpm recursive install.

Optional (type:string) Working directory when runpnpm [recursive] install.

Optional (type:string[]) Additional arguments afterpnpm [recursive] install, e.g.[--ignore-scripts, --strict-peer-dependencies].

Optional (type:boolean,default:false) Whether to cache the pnpm store directory.

Optional (type:string|string[],default:pnpm-lock.yaml) File path to the pnpm lockfile, which contents hash will be used as a cache key.

Optional (type:string,default:package.json) File path to thepackage.json/package.yaml to read "packageManager" configuration.

Optional (type:boolean,default:false) When set to true,@pnpm/exe, which is a Node.js bundled package, will be installed, enabling usingpnpm without Node.js.

This is useful when you want to use a incompatible pair of Node.js and pnpm.

Expanded path of inputs#dest.

Location ofpnpm andpnpx command.

This works when the repo either doesn't have apackage.json or has apackage.json but it doesn't specifypackageManager.

on:  -push  -pull_requestjobs:install:runs-on:ubuntu-lateststeps:      -uses:pnpm/action-setup@v4with:version:10

Omitversion input to use the version in thepackageManager field in thepackage.json.

on:  -push  -pull_requestjobs:install:runs-on:ubuntu-lateststeps:      -uses:pnpm/action-setup@v4

on:  -push  -pull_requestjobs:install:runs-on:ubuntu-lateststeps:      -uses:actions/checkout@v4      -uses:pnpm/action-setup@v4with:version:10run_install:|            - recursive:true              args: [--strict-peer-dependencies]            - args: [--global, gulp, prettier, typescript]

on:  -push  -pull_requestjobs:cache-and-install:runs-on:ubuntu-lateststeps:      -name:Checkoutuses:actions/checkout@v4      -uses:pnpm/action-setup@v4name:Install pnpmwith:version:10cache:true      -name:Install dependenciesrun:pnpm install

Note: You don't need to runpnpm store prune at the end; post-action has already taken care of that.

This action does not setup Node.js for you, useactions/setup-node yourself.

MIT ©Hoàng Văn Khải