Go to file
Jacob Gillespie fdbc93ea6e
Add disclaimer to pnpm action example, pin action
2021-07-14 13:03:28 +01:00
.github Add pnpm caching support 2021-06-30 20:17:23 +01:00
.licenses/npm update dependencies 2021-06-30 13:08:07 +03:00
.vscode download from node-versions and fallback to node dist (#147) 2020-05-19 09:25:54 -04:00
__tests__ Update __tests__/cache-save.test.ts 2021-07-14 13:01:18 +01:00
dist Add pnpm caching support 2021-06-30 20:17:23 +01:00
docs update readme 2021-06-30 15:07:45 +03:00
externals Initial Import 2019-08-03 21:49:54 -04:00
src Add pnpm caching support 2021-06-30 20:17:23 +01:00
.gitattributes remove eol in gitattributes 2021-06-17 17:20:16 +03:00
.gitignore download from node-versions and fallback to node dist (#147) 2020-05-19 09:25:54 -04:00
.licensed.yml regenerate license (#7) 2021-06-29 13:34:35 +03:00
.prettierrc.json Initial Import 2019-08-03 21:49:54 -04:00
CODEOWNERS Add CODEOWNERS 2020-12-07 16:08:14 -05:00
CONDUCT add code of conduct 2020-04-16 14:00:00 -04:00
LICENSE Initial Import 2019-08-03 21:49:54 -04:00
README.md Add disclaimer to pnpm action example, pin action 2021-07-14 13:03:28 +01:00
action.yml Add pnpm caching support 2021-06-30 20:17:23 +01:00
jest.config.js Initial Import 2019-08-03 21:49:54 -04:00
package-lock.json update dependencies 2021-06-30 13:08:07 +03:00
package.json Add node's caching implementation (#2) 2021-06-16 09:52:44 +03:00
tsconfig.json download from node-versions and fallback to node dist (#147) 2020-05-19 09:25:54 -04:00

README.md

setup-node

build-test status versions status proxy status

This action provides the following functionality for GitHub Actions users:

  • Optionally downloading and caching distribution of the requested Node.js version, and adding it to the PATH
  • Optionally caching npm/pnpm/yarn dependencies
  • Registering problem matchers for error output
  • Configuring authentication for GPR or npm

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
  with:
    node-version: '14'
- run: npm install
- run: npm test

The node-version input is optional. If not supplied, the node version from PATH will be used. However, it is recommended to always specify Node.js version and don't rely on the system one.

The action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Node.js. It will pull LTS versions from node-versions releases and on miss or failure will fall back to the previous behavior of downloading directly from node dist.

For information regarding locally cached versions of Node.js on GitHub hosted runners, check out GitHub Actions Virtual Environments.

Supported version syntax

The node-version input supports the following syntax:

major versions: 12, 14, 16
more specific versions: 10.15, 14.2.0, 16.3.0
nvm lts syntax: lts/erbium, lts/fermium, lts/*

Caching packages dependencies

The action has a built-in functionality for caching and restoring npm/yarn dependencies. Supported package managers are npm, pnpm, yarn. The cache input is optional, and caching is turned off by default.

Caching npm dependencies:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
  with:
    node-version: '14'
    cache: 'npm'
- run: npm install
- run: npm test

Caching pnpm dependencies:

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

steps:
- uses: actions/checkout@v2
- uses: pnpm/action-setup@646cdf48217256a3d0b80361c5a50727664284f2
  with:
    version: 6.9.0
- uses: actions/setup-node@v2
  with:
    node-version: '14'
    cache: 'pnpm'
- run: pnpm install
- run: pnpm test

Caching yarn dependencies:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
  with:
    node-version: '14'
    cache: 'yarn'
- run: yarn install
- run: yarn test

Yarn caching handles both yarn versions: 1 or 2.

At the moment, only lock files in the project root are supported.

Matrix Testing:

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node: [ '12', '14', '16' ]
    name: Node ${{ matrix.node }} sample
    steps:
      - uses: actions/checkout@v2
      - name: Setup node
        uses: actions/setup-node@v2
        with:
          node-version: ${{ matrix.node }}
      - run: npm install
      - run: npm test

Advanced usage

  1. Check latest version
  2. Using different architectures
  3. Using multiple operating systems and architectures
  4. Publishing to npmjs and GPR with npm
  5. Publishing to npmjs and GPR with yarn
  6. Using private packages

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome! See Contributor's Guide

Code of Conduct

👋 Be nice. See our code of conduct