Skip to content

fix: improve configuration consistency (casing)#8355

Merged
jeremylong merged 6 commits intomainfrom
scratch/documentation
Mar 15, 2026
Merged

fix: improve configuration consistency (casing)#8355
jeremylong merged 6 commits intomainfrom
scratch/documentation

Conversation

@jeremylong
Copy link
Copy Markdown
Collaborator

Description of Change

Used amp to check if we had any inconsistencies between configuration names and documentation. When incorrectly cased configuration items were found, the old field/property/etc. was deprecated, and the correctly cased variant was added.

@jeremylong jeremylong requested a review from chadlwilson March 7, 2026 19:18
@boring-cyborg boring-cyborg Bot added ant changes to ant cli changes to the cli documentation site documentation maven changes to the maven plugin labels Mar 7, 2026
@jeremylong jeremylong marked this pull request as ready for review March 7, 2026 19:18
Copy link
Copy Markdown
Collaborator

@chadlwilson chadlwilson left a comment

Choose a reason for hiding this comment

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

Things missed:

  • ant/src/test/resources/build.xml still referring to deprecated capitalizations. Should be updated.
  • cli/src/main/resources/completion-for-dependency-check.sh still refers to deprecated capitalization, should not.
  • CLI: missed to correct --disableRetireJS

Comment thread ant/src/main/java/org/owasp/dependencycheck/taskdefs/Check.java Outdated
Comment thread ant/src/main/java/org/owasp/dependencycheck/taskdefs/Check.java Outdated
Comment thread cli/src/main/java/org/owasp/dependencycheck/CliParser.java Outdated
Comment thread cli/src/main/java/org/owasp/dependencycheck/CliParser.java Outdated
Comment thread cli/src/main/java/org/owasp/dependencycheck/CliParser.java Outdated
Comment thread cli/src/main/java/org/owasp/dependencycheck/CliParser.java Outdated
@nhumblot
Copy link
Copy Markdown
Collaborator

suggestion(non-blocking): it may be scope creep and fitting more into an additional PR, this comment is more to raise the discussion. In order to assist the migration from the deprecated parameters to the new ones before the removal of the old parameters, could we consider adding warning logs in the form of:

[WARN] 'retirejsFilter' is deprecated and may be removed in the next major release, please migrate to 'retireJsFilter'

?

This may incentivize our users to switch prior the major version and ease their migration.

I am considering doing something similar for the ossIndex url, so it could fit in an additional change. If we prefer to add this change in a following PR, I can create a task.

@marcelstoer
Copy link
Copy Markdown
Collaborator

@nhumblot I fully support your proposal.

@jeremylong
Copy link
Copy Markdown
Collaborator Author

Thanks for the feedback - I'll try to incorporate this over the weekend.

@boring-cyborg boring-cyborg Bot added the tests test cases label Mar 14, 2026
@jeremylong jeremylong requested a review from chadlwilson March 14, 2026 12:08
Copy link
Copy Markdown
Collaborator

@chadlwilson chadlwilson left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jeremylong !

@jeremylong jeremylong merged commit 2150366 into main Mar 15, 2026
15 checks passed
@jeremylong jeremylong deleted the scratch/documentation branch March 15, 2026 18:04
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Apr 15, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

ant changes to ant cli changes to the cli documentation site documentation maven changes to the maven plugin tests test cases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants