Go to file
MaksimZhukov 270253e841
Merge pull request #327 from WtfJoke/addCacheHitOutPut
Add 'cache-hit' as output
2021-09-24 18:27:23 +03:00
.github rm __tests__/verify-no-unstaged-changes.sh 2021-09-16 10:54:26 -04: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__ Add 'cache-hit' as output 2021-09-23 13:17:32 +00:00
dist Add 'cache-hit' as output 2021-09-23 13:17:32 +00:00
docs update readme and dist files 2021-08-05 12:00:47 +00:00
externals Initial Import 2019-08-03 21:49:54 -04:00
src Add 'cache-hit' as output 2021-09-23 13:17:32 +00: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 update readme and dist files 2021-08-05 12:00:47 +00:00
action.yml Add 'cache-hit' as output 2021-09-23 13:17:32 +00: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/yarn/pnpm 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 dependencies. It uses actions/cache under hood for caching dependencies but requires less configuration settings. Supported package managers are npm, yarn, pnpm (v6.10+). The cache input is optional, and caching is turned off by default.

The action defaults to search for the dependency file (package-lock.json or yarn.lock) in the repository root, and uses its hash as a part of the cache key. Use cache-dependency-path for cases when multiple dependency files are used, or they are located in different subdirectories.

See the examples of using cache for yarn / pnpm and cache-dependency-path input in the Advanced usage guide.

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 npm dependencies in monorepos:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
  with:
    node-version: '14'
    cache: 'npm'
    cache-dependency-path: subdir/package-lock.json
- run: npm install
- run: npm test

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. Caching packages dependencies
  4. Using multiple operating systems and architectures
  5. Publishing to npmjs and GPR with npm
  6. Publishing to npmjs and GPR with yarn
  7. 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