0b715c7ebb
docs: update the caching example |
||
---|---|---|
.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]
.
package_json_file
Optional File path to the package.json
to read "packageManager" configutation. If not specified, package.json
in the project root directory is used.
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
with:
version: 8
Install pnpm and a few npm packages
on:
- push
- pull_request
jobs:
install:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
with:
version: 8
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:
- name: Checkout
uses: actions/checkout@v3
- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 16
- uses: pnpm/action-setup@v2
name: Install pnpm
with:
version: 7
run_install: false
- name: Get pnpm store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
- uses: actions/cache@v3
name: Setup pnpm cache
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
run: pnpm install
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.