This commit is contained in:
Collins Daily Hub 2025-04-10 08:27:40 +00:00 committed by GitHub
commit c9590b5e94
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,43 +1,24 @@
name: 'Setup Node.js environment' - name: Setup Node.js environment
description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.' uses: actions/setup-node@v4.3.0
author: 'GitHub' with:
inputs: # Set always-auth in npmrc.
always-auth: always-auth: # optional, default is false
description: 'Set always-auth in npmrc.' # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.
default: 'false' node-version: # optional
node-version: # File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.
description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.' node-version-file: # optional
node-version-file: # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.
description: 'File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.' architecture: # optional
architecture: # Set this option if you want the action to check for the latest available version that satisfies the version spec.
description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.' check-latest: # optional
check-latest: # 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.
description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.' registry-url: # optional
default: false # 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/).
registry-url: scope: # optional
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.' # 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.
scope: token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }}
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/).' # Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.
token: cache: # optional
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. # 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.
default: ${{ github.server_url == 'https://github.com' && github.token || '' }} cache-dependency-path: # optional
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.'
mirror:
description: 'Used to specify an alternative mirror to downlooad Node.js binaries from'
mirror-token:
description: 'The token used as Authorization header when fetching from the mirror'
# 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()