actions-on-packages/Setup Node.js environment
Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Dec 27, 2022
- License
- MIT
- Runtime
- Deprecated runtime
Pinned Snippet
uses: actions-on-packages/setup-node@92a57f4a935efe978b0a4d8e5b19fb42658c7ef7 # v4.0.3tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| always-auth | Set always-auth in npmrc. | — | false |
| node-version | Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0. | — | — |
| node-version-file | File containing the version Spec of the version to use. Examples: .nvmrc, .node-version, .tool-versions. | — | — |
| architecture | Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default. | — | — |
| check-latest | Set this option if you want the action to check for the latest available version that satisfies the version spec. | — | false |
| registry-url | Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN. | — | — |
| scope | Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | — | — |
| token | Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | — | ${{ github.server_url == 'https://github.com' && github.token || '' }} |
| cache | Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm. | — | — |
| cache-dependency-path | Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies. | — | — |
Outputs
| name | description |
|---|---|
| cache-hit | A boolean value to indicate if a cache was hit. |
| node-version | The installed node version. |