Skip to content

Conversation

@rjrudin
Copy link
Contributor

@rjrudin rjrudin commented Oct 29, 2025

Removes the markdown-it vulnerability. Also moved instructions for generating docs from README to CONTRIBUTING.

Copilot AI review requested due to automatic review settings October 29, 2025 14:25
@github-actions
Copy link

github-actions bot commented Oct 29, 2025

Copyright Validation Results
Total: 8 | Passed: 2 | Failed: 0 | Skipped: 6 | at: 2025-10-29 15:42:21 UTC | commit: a8c447e

⏭️ Skipped (Excluded) Files

  • .copyrightconfig
  • CONTRIBUTING.md
  • README.md
  • jsdoc.json
  • package-lock.json
  • package.json

✅ Valid Files

  • gulpfile.js
  • test-complete-proxy/gulpfile.js

✅ All files have valid copyright headers!

Copy link

Copilot AI left a comment

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 removes the gulp-jsdoc3 dependency to address a markdown-it vulnerability and replaces it with direct JSDoc usage. The change simplifies the documentation generation process by eliminating the gulp wrapper and updates the copyright notice in the JSDoc configuration.

  • Replaced gulp-jsdoc3 with direct jsdoc CLI usage in the npm script
  • Moved documentation generation instructions from README to CONTRIBUTING.md
  • Updated copyright notice in JSDoc configuration

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Removed gulp-jsdoc3 dependency, updated JSDoc version, and changed doc script to use JSDoc directly
jsdoc.json Updated copyright notice to reflect current company ownership
gulpfile.js Removed the doc function that used gulp-jsdoc3
README.md Removed documentation generation instructions section
CONTRIBUTING.md Added documentation generation instructions and removed related package override explanations

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

CONTRIBUTING.md Outdated
Comment on lines 62 to 65
After installing the project dependencies (including the [gulp](http://gulpjs.com/)
build system), you can build the reference documentation locally from the root
directory of the marklogic package:

Copy link

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

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

The documentation mentions gulp as a requirement for building documentation, but the new documentation generation process uses JSDoc directly and no longer requires gulp. This should be updated to reflect the current implementation.

Suggested change
After installing the project dependencies (including the [gulp](http://gulpjs.com/)
build system), you can build the reference documentation locally from the root
directory of the marklogic package:
After installing the project dependencies, you can build the reference documentation locally from the root
directory of the marklogic package using JSDoc:

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated

npm run doc

The documentation is generated in the `./doc` gitignore'd directory. The documentation can also be
Copy link

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

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

Corrected 'gitignore'd' to 'gitignored' for proper grammar.

Suggested change
The documentation is generated in the `./doc` gitignore'd directory. The documentation can also be
The documentation is generated in the `./doc` gitignored directory. The documentation can also be

Copilot uses AI. Check for mistakes.
@rjrudin rjrudin force-pushed the feature/jsdoc branch 4 times, most recently from a95457f to 70b9d21 Compare October 29, 2025 15:41
Removes the markdown-it vulnerability. Also moved instructions for generating docs from README to CONTRIBUTING.
@rjrudin rjrudin merged commit 2d38258 into develop Oct 29, 2025
3 checks passed
@rjrudin rjrudin deleted the feature/jsdoc branch October 29, 2025 16:02
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.

2 participants