Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the minimum required Node engine version to 8.15.0 #36033

Merged
merged 1 commit into from
Aug 14, 2019

Conversation

settermjd
Copy link
Contributor

Description

Update the minimum required Node engine version to 8.15.0.

Related Issue

  • Fixes <issue_link>

Motivation and Context

4f9a936, through dependabot[bot], updated the minimum required jsdoc version to ~3.6.2 from ~3.5.5. Version 3.6.2 requires a minimum node version of 8.15.0. However, the commit didn't update the minimum node engine version in build/package.json.

While node 8.15.0 is a relatively old version now, (the currently recommended versions are 10.16.2 and 12.8.0), if at least that version's not available, then when running make install-nodejs-deps, the user will encounter the following error:

error [email protected]: The engine "node" is incompatible with this module. Expected version ">=8.15.0". Got "8.13.0"
error Found incompatible module
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
make: *** [Makefile:166: build/node_modules] Error 1

How Has This Been Tested?

I encountered this error as the version of node that I had installed at the time (via npm), when running make was 8.13.0. After I updated to the latest stable version (12.8.0) the error is no longer encountered, and all of the JavaScript dependencies are successfully installed.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Database schema changes (next release will require increase of minor version instead of patch)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation ticket raised:

Open tasks:

  • Backport (if applicable set "backport-request" label and remove when the backport was done)

eca2e63 updated the minimum required jsdoc version to "~3.6.2". This
version requires a minimum node version of 8.15.0
(https://github.com/jsdoc/jsdoc/blob/master/package.json#L48). However,
the commit didn't update the minimum node engine version in
build/package.json.

While node 8.15.0 is a relatively old version now, if it's not
available, when running make install-nodejs-deps, the user will
encounter the following error:

error [email protected]: The engine "node" is incompatible with this module. Expected version ">=8.15.0". Got "8.13.0"
error Found incompatible module
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
make: *** [Makefile:166: build/node_modules] Error 1

This change prevents this from occurring.
@codecov
Copy link

codecov bot commented Aug 14, 2019

Codecov Report

Merging #36033 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #36033   +/-   ##
=======================================
  Coverage   53.85%   53.85%           
=======================================
  Files          63       63           
  Lines        7377     7377           
  Branches     1301     1301           
=======================================
  Hits         3973     3973           
  Misses       3019     3019           
  Partials      385      385
Flag Coverage Δ
#javascript 53.85% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2908c40...7a63fe4. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Aug 14, 2019

Codecov Report

Merging #36033 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #36033   +/-   ##
=======================================
  Coverage   53.85%   53.85%           
=======================================
  Files          63       63           
  Lines        7377     7377           
  Branches     1301     1301           
=======================================
  Hits         3973     3973           
  Misses       3019     3019           
  Partials      385      385
Flag Coverage Δ
#javascript 53.85% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2908c40...7a63fe4. Read the comment docs.

@DeepDiver1975 DeepDiver1975 merged commit 8e59797 into master Aug 14, 2019
@delete-merged-branch delete-merged-branch bot deleted the update-minimum-required-node-engine-version branch August 14, 2019 13:38
@davitol davitol mentioned this pull request Sep 3, 2019
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants