nickofthyme/Checkout node setup

Checkout, setup and install node with dependencies

View on GitHub

Trust Signals

Scorecard Score: Scorecard 2–4scored Jul 6, 2026
Maintenance Recency: Stalelast commit Mar 23, 2023
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: nickofthyme/checkout-node-setup@fd73010e8ea31fc4b00acbe8c1496e51e7bf3739 # v2.0.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
skip-checkout	Skip checkout step	no	false
skip-setup-node	Skip node setup step	no	false
skip-npm-install	Skip npm install step	no	false
checkout-token	Personal access token (PAT) used to fetch the repository. The PAT is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the PAT. We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)	no	${{ github.token }}
setup-node-token	Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user.	no	${{ github.token }}
repository	Repository name with owner. For example, actions/checkout	no	${{ github.repository }}
ref	The branch, tag or SHA to checkout. When checking out the repository that triggered a workflow, this defaults to the reference or SHA for that event. Otherwise, uses the default branch.	no	—
ssh-key	SSH key used to fetch the repository. The SSH key is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the SSH key. We recommend using a service account with the least permissions necessary. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)	no	—
ssh-known-hosts	Known hosts in addition to the user and global host key database. The public SSH keys for a host may be obtained using the utility `ssh-keyscan`. For example, `ssh-keyscan github.com`. The public key for github.com is always implicitly added.	no	—
ssh-strict	Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to configure additional hosts.	no	true
persist-credentials	Whether to configure the token or SSH key with the local git config	no	false
path	Relative path under $GITHUB_WORKSPACE to place the repository	no	—
clean	Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching	no	true
fetch-depth	Number of commits to fetch. 0 indicates all history for all branches and tags.	no	1
lfs	Whether to download Git-LFS files	no	false
submodules	Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules. When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are converted to HTTPS.	no	false
always-auth	Set always-auth in npmrc	no	false
node-version	Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0	no	—
node-version-file	File containing the version Spec of the version to use. Examples: .nvmrc, .node-version	no	—
architecture	Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.	no	—
check-latest	Set this option if you want the action to check for the latest available version that satisfies the version spec	no	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	no	—
scope	Optional scope for authenticating against scoped registries	no	—
cache	Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm	no	—
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.	no	—
working-directory	Working directory to specify subfolder in which dependencies are defined	no	—
useLockFile	Option to enable or disable use of a lock file (package-lock.json/yarn.lock)	no	—
useRollingCache	Option to enable restoring a cache that doesn't exactly match the lockfile, and expire once a month to keep it from only growing larger	no	true
install-command	Custom install command to use	no	—

Outputs

no outputs