feat(node-version-file): support parsing `devEngines` field by susnux · Pull Request #1283 · actions/setup-node · GitHub
Skip to content

feat(node-version-file): support parsing devEngines field#1283

Merged
HarithaVattikuti merged 5 commits into
actions:mainfrom
susnux:feat/support-dev-engines
Feb 23, 2026
Merged

feat(node-version-file): support parsing devEngines field#1283
HarithaVattikuti merged 5 commits into
actions:mainfrom
susnux:feat/support-dev-engines

Conversation

@susnux

@susnux susnux commented Apr 20, 2025

Copy link
Copy Markdown
Contributor

Description:
Currently if you want to support multiple versions for running (e.g. a library) but enforce a specific version for development you can set devEngines with npm 11.
This PR adds support for parsing the devEngines.runtime field (if it is set to node) for allowing automatic setup.

Related issue:

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

@susnux susnux requested a review from a team as a code owner April 20, 2025 11:24
@zanminkian

Copy link
Copy Markdown

@susnux

This comment was marked as outdated.

Comment thread src/util.ts
Comment thread __tests__/main.test.ts Outdated
Comment thread __tests__/data/package-dev-engines.json Outdated
Comment thread .github/workflows/versions.yml
Comment thread docs/advanced-usage.md Outdated
@susnux

This comment was marked as resolved.

@sdavids

sdavids commented Jul 11, 2025

Copy link
Copy Markdown

@gowridurgad Could we please get this reviewed …

@susnux

susnux commented Aug 11, 2025

Copy link
Copy Markdown
Contributor Author

@HarithaVattikuti anything I can help with pushing this forward?

@susnux

susnux commented Oct 15, 2025

Copy link
Copy Markdown
Contributor Author

I saw you reviewed similar requests @aparnajyothi-y @priya-kinthali maybe you can have a look?
(I am not sure whats the process here, but as this is open for some months)

@SunsetTechuila

Copy link
Copy Markdown
Contributor

(I am not sure whats the process here, but as this is open for some months)

That's normal for this repo. You can't really do anything to speed up the process

@zanminkian

Copy link
Copy Markdown

Here is a workaround to support devEngines:

      - uses: actions/checkout@v4
      # TODO: Remove this step when https://github.com/actions/setup-node/pull/1283 is merged
      - name: Get Node.js version
        id: get-node-version
        run: |
          node_version=$(jq -r '.devEngines.runtime.version // empty' package.json)
          if [ -z "$node_version" ]; then
            echo "Error: No Node.js version specified in devEngines.runtime.version"
            exit 1
          fi
          echo "node-version=$node_version" >> $GITHUB_OUTPUT
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ steps.get-node-version.outputs.node-version }}

@aparnajyothi-y

Copy link
Copy Markdown
Contributor

Hello @susnux, Closing and reopening this to trigger the checks

@aparnajyothi-y aparnajyothi-y reopened this Feb 3, 2026
Copilot Bot review requested due to automatic review settings February 3, 2026 12:57
@susnux susnux force-pushed the feat/support-dev-engines branch from 25df5cd to bf6720e Compare February 3, 2026 12:57
@susnux

susnux commented Feb 3, 2026

Copy link
Copy Markdown
Contributor Author

@aparnajyothi-y sure but for CI to succeed I think I had to compile the assets (npm build).

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR extends getNodeVersionFromFile to support the devEngines.runtime field in package.json, allowing the action to prefer a development Node version where defined (as in npm 11). It also documents the new resolution order, adds unit and workflow tests for the new behavior, and updates the prebuilt dist artifacts accordingly.

Changes:

  • Update src/util.ts (and compiled dist files) to read manifest.devEngines.runtime (object or array) and return the matching node entry’s version, with precedence between volta.node and engines.node.
  • Expand documentation in docs/advanced-usage.md to describe the new lookup order and provide examples of devEngines usage.
  • Add Jest tests and workflow jobs with sample package.json fixtures to verify both object and array devEngines.runtime forms.

Reviewed changes

Copilot reviewed 6 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/util.ts Adds devEngines.runtime support into getNodeVersionFromFile, between volta.node and engines.node, and keeps Volta workspace recursion behavior.
docs/advanced-usage.md Documents the new resolution order, including devEngines.runtime, and adds examples for devEngines and Volta-pinned Node versions.
dist/setup/index.js Regenerated build output reflecting the new devEngines.runtime handling for setup.
dist/cache-save/index.js Regenerated build output reflecting the new devEngines.runtime handling for cache-save.
tests/main.test.ts Extends the parameterized tests for getNodeVersionFromFile to cover devEngines.runtime as both an object and an array.
tests/data/package-dev-engines.json New fixture defining engines.node and a single-object devEngines.runtime for workflow testing.
tests/data/package-dev-engines-array.json New fixture defining engines.node and an array-form devEngines.runtime for workflow testing.
.github/workflows/versions.yml Adds matrix jobs that verify Node resolution from the new package-dev-engines fixtures across multiple OSes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/util.ts
Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md Outdated
@susnux susnux force-pushed the feat/support-dev-engines branch from bfda8eb to abd5abb Compare February 3, 2026 13:09
@gowridurgad

Copy link
Copy Markdown
Contributor

Hello @susnux, thank you for the contribution and for taking the time to add devEngines support.

During review, we noticed a few points to address:

  • Since tests/main.test.ts already covers both devEngines.runtime forms (object and array), could you please keep a single workflow job and remove the extra job to reduce CI minutes?
  • Could you also update the workflow/test setup to the latest versions (e.g., actions/checkout, macos-15-intel, and the Node versions used in CI)? Please remove macos-13 as it is deprecated.
  • In the advanced usage documentation, could you consolidate the multiple examples into a single representative example placed below the explanation, illustrating how the Node.js version is resolved from package.json, for example:
{
  "engines": {
    "node": "^19"
  },
  "volta": {
    "node": "16.0.0"
  },
  "devEngines": {
    "runtime": {
      "name": "node",
      "version": "^20.10"
    }
  }
}

@SunsetTechuila

This comment was marked as outdated.

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
@susnux susnux force-pushed the feat/support-dev-engines branch from bc646a9 to c93e035 Compare February 23, 2026 10:02
@susnux

susnux commented Feb 23, 2026

Copy link
Copy Markdown
Contributor Author

@HarithaVattikuti HarithaVattikuti merged commit 774c1d6 into actions:main Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support devEngines field in package.json

10 participants