2019-08-12 19:39:33 +01:00
name : 'Setup Node.js environment'
2020-05-19 14:25:54 +01:00
description : 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH'
2019-08-04 02:49:54 +01:00
author : 'GitHub'
2019-08-13 21:32:09 +01:00
inputs :
2019-09-03 15:57:45 +01:00
always-auth :
description : 'Set always-auth in npmrc'
default : 'false'
2019-08-13 21:32:09 +01:00
node-version :
2020-05-19 14:25:54 +01: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 :
description: 'File containing the version Spec of the version to use. Examples : .nvmrc, .node-version'
2020-12-08 22:15:38 +00:00
architecture :
2020-09-03 13:15:06 +01:00
description: 'Target architecture for Node to use. Examples : x86, x64. Will use system architecture by default.'
2020-06-29 19:56:37 +01:00
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
2019-08-06 23:26:04 +01:00
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'
2020-05-19 14:25:54 +01:00
token :
description : Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user.
default : ${{ github.token }}
2021-06-16 07:52:44 +01:00
cache :
2021-07-15 20:14:30 +01:00
description: 'Used to specify a package manager for caching in the default directory. Supported values : npm, yarn, pnpm'
2021-08-02 18:44:59 +01:00
cache-dependency-path :
2021-08-05 13:00:47 +01: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.'
2020-05-19 14:25:54 +01:00
# 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
2019-08-13 21:32:09 +01:00
# Deprecated option, do not use. Will not be supported after October 1, 2019
version :
description : 'Deprecated. Use node-version instead. Will not be supported after October 1, 2019'
2019-09-12 15:30:15 +01:00
deprecationMessage : 'The version property will not be supported after October 1, 2019. Use node-version instead'
2021-09-03 19:34:37 +01:00
outputs :
cache-hit :
description : 'A boolean value to indicate if a cache was hit'
2019-08-04 02:49:54 +01:00
runs :
using : 'node12'
2021-06-16 07:52:44 +01:00
main : 'dist/setup/index.js'
post : 'dist/cache-save/index.js'
post-if : success()