mirror of
https://github.com/actions/setup-node
synced 2024-12-22 13:12:43 +00:00
39 lines
2.4 KiB
YAML
39 lines
2.4 KiB
YAML
name: 'Setup Node.js environment'
|
|
description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.'
|
|
author: 'GitHub'
|
|
inputs:
|
|
always-auth:
|
|
description: 'Set always-auth in npmrc.'
|
|
default: 'false'
|
|
node-version:
|
|
description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.'
|
|
node-version-file:
|
|
description: 'File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.'
|
|
architecture:
|
|
description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.'
|
|
check-latest:
|
|
description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.'
|
|
default: false
|
|
registry-url:
|
|
description: '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:
|
|
description: '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:
|
|
description: 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.
|
|
default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
|
|
cache:
|
|
description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.'
|
|
cache-dependency-path:
|
|
description: '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.'
|
|
# TODO: add input to control forcing to pull from cloud or dist.
|
|
# escape valve for someone having issues or needing the absolute latest which isn't cached yet
|
|
outputs:
|
|
cache-hit:
|
|
description: 'A boolean value to indicate if a cache was hit.'
|
|
node-version:
|
|
description: 'The installed node version.'
|
|
runs:
|
|
using: 'node20'
|
|
main: 'dist/setup/index.js'
|
|
post: 'dist/cache-save/index.js'
|
|
post-if: success()
|