docs: correct missing documentation for Gradle plugin#8431
Merged
jeremylong merged 7 commits intodependency-check:mainfrom Apr 19, 2026
Merged
docs: correct missing documentation for Gradle plugin#8431jeremylong merged 7 commits intodependency-check:mainfrom
jeremylong merged 7 commits intodependency-check:mainfrom
Conversation
The old properties are deprecated; extension was introduced. Signed-off-by: Chad Wilson <[email protected]>
Signed-off-by: Chad Wilson <[email protected]>
These should really be moved to the individual analyzer extensions, so maybe we should avoid documenting them? I dunno. Signed-off-by: Chad Wilson <[email protected]>
Signed-off-by: Chad Wilson <[email protected]>
- It was also referred to as Node.js Analyzer / Node.js Package Analyzer in various places. - It was also temporarily retired and then unretired so there is some out of date documentation. Signed-off-by: Chad Wilson <[email protected]>
boring-cyborg
Bot
added
ant
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation and user-facing strings to consistently use “Node Package Analyzer” terminology and to document previously missing Gradle plugin configuration options.
Changes:
- Standardize “Node Package Analyzer” naming across core analyzer name, CLI help, Maven/Ant docs, and analyzer docs.
- Expand Gradle plugin configuration docs to include additional properties (e.g.,
showSummary, cache options, nexus/nodePackage groups). - Update/realign CLI and Maven parameter documentation to include
nodePackageSkipDevDependencies.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| utils/src/main/java/org/owasp/dependencycheck/utils/Settings.java | Updates settings key Javadoc terminology for node package analyzer. |
| src/site/markdown/dependency-check-gradle/configuration.md | Adds missing Gradle plugin configuration entries (summary, cache, nexus/nodePackage groups). |
| src/site/markdown/dependency-check-gradle/configuration-aggregate.md | Mirrors the Gradle aggregate configuration documentation updates. |
| src/site/markdown/analyzers/nodejs.md | Renames analyzer page heading to “Node Package Analyzer”. |
| src/site/markdown/analyzers/index.md | Renames analyzer index entry from “Node.js” to “Node Package”. |
| maven/src/site/markdown/configuration.md | Updates Maven plugin docs to reflect Node Package Analyzer + skip-dev option. |
| maven/src/main/java/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.java | Updates parameter Javadocs to “Node Package Analyzer”. |
| core/src/test/java/org/owasp/dependencycheck/analyzer/NodePackageAnalyzerTest.java | Updates test expectation for analyzer display name. |
| core/src/main/java/org/owasp/dependencycheck/analyzer/NodePackageAnalyzer.java | Renames analyzer display name constant. |
| cli/src/site/markdown/arguments.md | Reorders/clarifies CLI arguments and removes duplicate entry for nodePackage skip-dev option. |
| cli/src/main/java/org/owasp/dependencycheck/CliParser.java | Updates CLI help text/Javadoc to “Node Package Analyzer”. |
| ant/src/site/markdown/configuration.md | Updates Ant docs to reflect Node Package Analyzer + skip-dev option. |
| ant/src/main/java/org/owasp/dependencycheck/taskdefs/Check.java | Updates Ant task field Javadoc terminology. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Chad Wilson <[email protected]>
Signed-off-by: Chad Wilson <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Change
There are some undocumented fields missed from various changes over time.
Also
Related issues
N/A
Have test cases been added to cover the new functionality?
N/A