2019-08-12 18:39:33 +00:00
name : 'Setup Node.js environment'
2022-04-19 17:43:19 +00:00
description : 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.'
2019-08-04 01:49:54 +00:00
author : 'GitHub'
2019-08-13 20:32:09 +00:00
inputs :
2019-09-03 14:57:45 +00:00
always - auth :
2022-04-19 17:43:19 +00:00
description : 'Set always-auth in npmrc.'
2019-09-03 14:57:45 +00:00
default : 'false'
2019-08-13 20:32:09 +00:00
node - version :
2022-04-19 17:43:19 +00:00
description : 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.'
2021-11-29 09:18:31 +00:00
node - version - file :
2021-12-01 15:44:59 +00:00
description : 'File containing the version Spec of the version to use. Examples: .nvmrc, .node-version, .tool-versions.'
2020-12-08 22:15:38 +00:00
architecture :
2020-09-03 12:15:06 +00:00
description : 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.'
2020-06-29 18:56:37 +00:00
check - latest :
2022-04-19 17:43:19 +00:00
description : 'Set this option if you want the action to check for the latest available version that satisfies the version spec.'
2020-06-29 18:56:37 +00:00
default : false
2019-08-06 22:26:04 +00:00
registry - url :
2022-04-19 17:43:19 +00:00
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.'
2019-08-06 22:26:04 +00:00
scope :
2022-04-19 17:43:19 +00:00
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/).'
2020-05-19 13:25:54 +00:00
token :
2022-11-02 11:24:44 +00:00
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 || '' } }
2021-06-16 06:52:44 +00:00
cache :
2022-04-19 17:43:19 +00:00
description : 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.'
2021-08-02 17:44:59 +00:00
cache - dependency - path :
2021-08-05 12:00:47 +00:00
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.'
2023-06-21 15:52:17 +00:00
# TODO : add input to control forcing to pull from cloud or dist .
2020-05-19 13:25:54 +00:00
# escape valve for someone having issues or needing the absolute latest which isn ' t cached yet
2021-09-03 18:34:37 +00:00
outputs :
cache - hit :
2022-04-19 17:43:19 +00:00
description : 'A boolean value to indicate if a cache was hit.'
2022-06-30 19:55:32 +00:00
node - version :
description : 'The installed node version.'
2019-08-04 01:49:54 +00:00
runs :
2022-02-22 08:28:24 +00:00
using : 'node16'
2021-06-16 06:52:44 +00:00
main : 'dist/setup/index.js'
post : 'dist/cache-save/index.js'
2022-02-22 08:28:24 +00:00
post - if : success ( )