setup-node/README.md

206 lines
6.8 KiB
Markdown
Raw Permalink Normal View History

2019-08-04 01:49:54 +00:00
# setup-node
2019-08-12 19:10:38 +00:00
<p align="left">
2020-05-19 13:57:20 +00:00
<a href="https://github.com/actions/setup-node/actions?query=workflow%3Abuild-test"><img alt="build-test status" src="https://github.com/actions/setup-node/workflows/build-test/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aversions"><img alt="versions status" src="https://github.com/actions/setup-node/workflows/versions/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aproxy"><img alt="proxy status" src="https://github.com/actions/setup-node/workflows/proxy/badge.svg"></a>
2019-08-12 19:10:38 +00:00
</p>
2019-08-04 01:49:54 +00:00
This action sets by node environment for use in actions by:
- optionally downloading and caching a version of node - npm by version spec and add to PATH
2020-05-06 13:58:52 +00:00
- registering problem matchers for error output
- configuring authentication for GPR or npm
2019-08-04 01:49:54 +00:00
2020-12-15 10:36:18 +00:00
# v2
2020-05-19 13:57:20 +00:00
2020-12-15 10:36:18 +00:00
This release adds reliability for pulling node distributions from a cache of node releases.
2020-05-19 13:57:20 +00:00
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
2020-05-19 13:57:20 +00:00
with:
node-version: '14'
2020-05-19 13:57:20 +00:00
```
The action will first check the local cache for a semver match. The hosted images have been updated with the latest of each LTS from v8, v10, v12, and v14. `self-hosted` machines will benefit from the cache as well only downloading once. The action will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/).
2020-05-19 13:57:20 +00:00
The `node-version` input is optional. If not supplied, the node version that is PATH will be used. However, this action will still register problem matchers and support auth features. So setting up the node environment is still a valid scenario without downloading and caching versions.
2020-05-19 13:57:20 +00:00
2019-08-04 01:49:54 +00:00
# Usage
See [action.yml](action.yml)
Basic:
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
2019-08-04 01:49:54 +00:00
with:
node-version: '14'
2019-08-04 01:49:54 +00:00
- run: npm install
- run: npm test
```
Check latest version:
In the basic example above, the `check-latest` flag defaults to `false`. When set to `false`, the action tries to first resolve a version of node from the local cache. For information regarding locally cached versions of Node on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments). The local version of Node in cache gets updated every couple of weeks. If unable to find a specific version in the cache, the action will then attempt to download a version of Node. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node is always used.
If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a version of Node will then be downloaded. Set `check-latest` to `true` it you want the most up-to-date version of Node to always be used.
> Setting `check-latest` to `true` has performance implications as downloading versions of Node is slower than using cached versions
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
node-version: '14'
check-latest: true
- run: npm install
- run: npm test
```
2019-08-04 01:49:54 +00:00
Matrix Testing:
```yaml
jobs:
build:
runs-on: ubuntu-16.04
strategy:
matrix:
node: [ '12', '14' ]
2019-08-04 01:49:54 +00:00
name: Node ${{ matrix.node }} sample
steps:
- uses: actions/checkout@v2
2019-08-04 01:49:54 +00:00
- name: Setup node
2020-12-15 10:36:18 +00:00
uses: actions/setup-node@v2
2019-08-04 01:49:54 +00:00
with:
node-version: ${{ matrix.node }}
2019-08-04 01:49:54 +00:00
- run: npm install
- run: npm test
```
2020-12-08 22:47:34 +00:00
Architecture:
You can use any of the [supported operating systems](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners), and the compatible `architecture` can be selected using `architecture`. Values are `x86`, `x64`, `arm64`, `armv6l`, `armv7l`, `ppc64le`, `s390x` (not all of the architectures are available on all platforms).
When using `architecture`, `node-version` must be provided as well.
```yaml
jobs:
build:
runs-on: windows-latest
name: Node sample
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
2020-12-08 22:47:34 +00:00
with:
node-version: '14'
2020-12-08 22:47:34 +00:00
architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default
- run: npm install
- run: npm test
```
Multiple Operating Systems and Architectures:
```yaml
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
node_version:
- 10
- 12
- 14
2020-12-08 22:15:38 +00:00
architecture:
- x64
# an extra windows-x86 run:
include:
- os: windows-2016
node_version: 12
2020-12-08 22:15:38 +00:00
architecture: x86
name: Node ${{ matrix.node_version }} - ${{ matrix.architecture }} on ${{ matrix.os }}
steps:
- uses: actions/checkout@v2
- name: Setup node
2020-12-15 10:36:18 +00:00
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node_version }}
2020-12-08 22:15:38 +00:00
architecture: ${{ matrix.architecture }}
- run: npm install
- run: npm test
```
Publish to npmjs and GPR with npm:
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
node-version: '10.x'
registry-url: 'https://registry.npmjs.org'
- run: npm install
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
registry-url: 'https://npm.pkg.github.com'
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Publish to npmjs and GPR with yarn:
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
node-version: '10.x'
registry-url: <registry url>
- run: yarn install
- run: yarn publish
env:
NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }}
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
registry-url: 'https://npm.pkg.github.com'
- run: yarn publish
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Use private packages:
```yaml
steps:
- uses: actions/checkout@v2
2020-12-15 10:36:18 +00:00
- uses: actions/setup-node@v2
with:
node-version: '10.x'
registry-url: 'https://registry.npmjs.org'
# Skip post-install scripts here, as a malicious
# script could steal NODE_AUTH_TOKEN.
- run: npm install --ignore-scripts
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
2019-09-27 12:31:22 +00:00
# `npm rebuild` will run all those post-install scripts for us.
- run: npm rebuild && npm run prepare --if-present
```
2019-08-04 01:49:54 +00:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
# Contributions
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
2020-04-16 22:43:02 +00:00
## Code of Conduct
:wave: Be nice. See [our code of conduct](CONDUCT)