ae78e9abbe
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> |
||
---|---|---|
.github | ||
dist | ||
src | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
action.yml | ||
LICENSE.md | ||
package.json | ||
pnpm-lock.yaml | ||
README.md | ||
renovate.json | ||
run.sh | ||
tsconfig.json |
Setup pnpm
Install pnpm package manager.
Inputs
version
Version of pnpm to install.
Optional when there is a packageManager
field in the package.json
.
otherwise, this field is required 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:
install:
runs-on: ubuntu-latest
steps:
- uses: pnpm/action-setup@v2.1.0
with:
version: 6.0.2
Install pnpm and a few npm packages
on:
- push
- pull_request
jobs:
install:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: pnpm/action-setup@v2.1.0
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:
cache-and-install:
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.1.0
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.