search

woocommerce / grow

7 stars 7 forks source link

Upgrade the npm dependency `jsdoc` to v4 for the JS package `jsdoc` #104

Closed eason9487 closed 6 months ago

eason9487 commented 6 months ago

Changes proposed in this Pull Request:

Please also review PR #103 and approve it as well once this PR is getting approval.

This PR upgrades the npm dependency jsdoc to v4 for the JS package jsdoc along with related deps

📌 Checklist before merging (@eason9487)

Detailed test instructions:

Check the validation sample for the jsdoc and tracking-jsdoc JS packages with npm jsdoc v3

  1. Set node to use v14
  2. git checkout 1485e2d9c3cf5eeb0c80815ec8564cf954470cf0 (Ref: 1485e2d9c3cf5eeb0c80815ec8564cf954470cf0)
  3. cd packages/js/jsdoc
  4. npm install
  5. npm ls jsdoc to check if the current jsdoc is v3
  6. npm run dev:doc:tracking
  7. View the generated content in samples/jsdoc/TRACKING.md before the upgrade

Test the changes with jsdoc v4

  1. Set node to use v14
  2. git checkout update/jsdoc-deps
  3. cd packages/js/jsdoc
  4. npm install
  5. npm ls jsdoc to check if the current jsdoc is v4
  6. npm run dev:doc:tracking
  7. Check if the generated content in samples/jsdoc/TRACKING.md is the same after the upgrade
  8. Inspect the generated content in a package user side Google Listings & Ads
eason9487 commented 6 months ago

I will be skipping the code review process as it can be optional for a devs-facing only change.