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.

Sign up for GitHub

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

Jump to bottom

Upgrade JS packages jsdoc and tracking-jsdoc to use Node.js v20 #110

Merged
merged 2 commits into from
Apr 23, 2024
Merged

Upgrade JS packages jsdoc and tracking-jsdoc to use Node.js v20 #110

merged 2 commits into from
Apr 23, 2024

Conversation

eason9487
Copy link
Member

@eason9487 eason9487 commented Apr 19, 2024 •
edited
Loading

Changes proposed in this Pull Request:

Part of #108

This PR:

  • Use Node.js v20 to regenerate the package-lock.json of JS package tracking-jsdoc.
  • Set minimum support for Node.js to v16.
  • Add the 'node:' prefix to explicitly indicate it requires a Node.js core module.
  • Avoid generating package-lock.json file after tracking-jsdoc installation when developing this repo.

💡 The <repo_directory>/.nvmrc will be updated in a separate PR.

Detailed test instructions:

  1. Use Node.js v20
  2. cd packages/js/jsdoc
  3. npm install
  4. npm run dev:doc:tracking
  5. Check if the generated content in <repo_directory>/samples/jsdoc/TRACKING.md is the same
  6. Repeat the test with Node.js v16

@eason9487 eason9487 self-assigned this Apr 19, 2024
@eason9487 eason9487 requested a review from a team April 19, 2024 06:15
@eason9487 eason9487 force-pushed the update/108-nodejs-v20-jsdoc branch 3 times, most recently from 634600a to 9ba01dd Compare April 22, 2024 06:33
@eason9487 eason9487 force-pushed the update/108-nodejs-v20-jsdoc branch from 9ba01dd to 05de223 Compare April 22, 2024 09:02
martynmjones
martynmjones approved these changes Apr 22, 2024
View reviewed changes
Copy link

@martynmjones martynmjones left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hey @eason9487, thanks for updating Node!

Tested locally with 20.5.0 / 16.20.2 and the generated content in TRACKING.md was identical so LGTM ✅

@eason9487 eason9487 merged commit d680842 into update/108-nodejs-v20 Apr 23, 2024
2 checks passed
@eason9487 eason9487 deleted the update/108-nodejs-v20-jsdoc branch April 23, 2024 02:19
@eason9487 eason9487 mentioned this pull request Apr 23, 2024
Closed
26 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martynmjones martynmjones martynmjones approved these changes

Assignees

@eason9487 eason9487

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eason9487 @martynmjones