README.md

GitHub Action: Setup Node.js

---

Overview

Action to setup Node.js and install dependencies according to the package manager used.

Usage

- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@97f64bc080b78daca8fb3ece49de448aaac83429 # 1.1.0
  with:
    # Install project dependencies after configuring Node.js and the package manager.
    # Set false when only tooling is needed, such as packaging prepared build files,
    # or when the caller manages dependency installation separately.
    #
    # Default: `true`
    install-dependencies: "true"

    # Disable project and dependency lifecycle scripts during installation.
    # Set false to allow installation hooks, subject to the package manager's script approval settings.
    # Explicit commands run after installation are unaffected.
    #
    # Default: `true`
    ignore-scripts: "true"

    # List of dependencies for which the cache should be managed
    dependencies-cache: ""

    # Working directory where the dependencies are installed.
    # Can be absolute or relative to the repository root.
    #
    # Default: `.`
    working-directory: .

    # Optional registry to set up for auth.
    # See https://github.com/actions/setup-node?tab=readme-ov-file#usage.
    registry-url: ""

Inputs

Input	Description	Required	Default
install-dependencies	Install project dependencies after configuring Node.js and the package manager.	false	true
	Set false when only tooling is needed, such as packaging prepared build files,
	or when the caller manages dependency installation separately.
ignore-scripts	Disable project and dependency lifecycle scripts during installation.	false	true
	Set false to allow installation hooks, subject to the package manager's script approval settings.
	Explicit commands run after installation are unaffected.
dependencies-cache	List of dependencies for which the cache should be managed	false	-
working-directory	Working directory where the dependencies are installed.	false	.
	Can be absolute or relative to the repository root.
registry-url	Optional registry to set up for auth.	false	-
	See https://github.com/actions/setup-node?tab=readme-ov-file#usage.

Outputs

Output	Description
run-script-command	The command to run a script in the package.json file

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.