Install pnpm package manager
Go to file
2022-02-08 00:21:53 +02:00
.github Update test workflow 2021-03-23 12:53:25 +07:00
dist PNPM_HOME_PATH=>PNPM_HOME 2022-02-08 00:21:53 +02:00
src PNPM_HOME_PATH=>PNPM_HOME 2022-02-08 00:21:53 +02:00
.editorconfig Update .editorconfig 2020-05-08 10:35:40 +07:00
.gitattributes Fix .gitattributes 2020-05-09 08:13:09 +07:00
.gitignore Add .pnpm-store to .gitignore 2021-03-23 12:48:07 +07:00
action.yml Use pnpm.js to install pnpm 2021-03-23 12:42:43 +07:00
LICENSE.md 2020 2020-02-26 17:29:08 +07:00
package.json The pnpm home directory should be added to PATH and PNPM_HOME 2022-02-07 23:15:44 +02:00
pnpm-lock.yaml The pnpm home directory should be added to PATH and PNPM_HOME 2022-02-07 23:15:44 +02:00
README.md Update README.md 2021-12-16 17:18:46 +03:00
renovate.json Instruct renovate to ignore ajv updates 2021-03-23 11:47:55 +07:00
run.sh Use pnpm.js to install pnpm 2021-03-23 12:42:43 +07:00
tsconfig.json Add TypeScript build step 2020-05-08 10:22:09 +07:00

Setup pnpm

Install pnpm package manager.

Inputs

version

Required Version of pnpm to install. It supports npm versioning scheme, it could be an exact version (such as 6.24.1), or a version range (such as 6, 6.x.x, 6.24.x, ^6.24.1, *, etc.), or latest.

dest

Optional Where to store pnpm files.

run_install

Optional (default: null) If specified, run pnpm install.

If run_install is either null or false, pnpm will not install any npm package.

If run_install is true, pnpm will install dependencies recursively.

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

run_install.recursive

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

run_install.cwd

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

run_install.args

Optional (type: string[]) Additional arguments after pnpm [recursive] install, e.g. [--frozen-lockfile, --strict-peer-dependencies].

Outputs

dest

Expanded path of inputs#dest.

bin_dest

Location of pnpm and pnpx command.

Usage example

Just install pnpm

on:
  - push
  - pull_request

jobs:
  runs-on: ubuntu-latest

  steps:
    - uses: pnpm/action-setup@v2.0.1
      with:
        version: 6.0.2

Install pnpm and a few npm packages

on:
  - push
  - pull_request

jobs:
  runs-on: ubuntu-latest

  steps:
    - uses: actions/checkout@v2

    - uses: pnpm/action-setup@v2.0.1
      with:
        version: 6.0.2
        run_install: |
          - recursive: true
            args: [--frozen-lockfile, --strict-peer-dependencies]
          - args: [--global, gulp, prettier, typescript]          

Use cache to reduce installation time

on:
  - push
  - pull_request

jobs:
  runs-on: ubuntu-latest

  steps:
    build:
      - uses: actions/checkout@v2

      - name: Cache pnpm modules
        uses: actions/cache@v2
        with:
          path: ~/.pnpm-store
          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-            

      - uses: pnpm/action-setup@v2.0.1
        with:
          version: 6.0.2
          run_install: true

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

Notes

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

License

MIT © Hoàng Văn Khải