Skip to content

docs: ensure OSS Index URL override is consistently documented#8338

Merged
nhumblot merged 3 commits intodependency-check:mainfrom
chadlwilson:fix-ossindex-docs
Mar 6, 2026
Merged

docs: ensure OSS Index URL override is consistently documented#8338
nhumblot merged 3 commits intodependency-check:mainfrom
chadlwilson:fix-ossindex-docs

Conversation

@chadlwilson
Copy link
Collaborator

@chadlwilson chadlwilson commented Mar 5, 2026

Description of Change

As noted in discussion of #8335 (reply in thread) the ability to override the OSS Index URL wasn't documented consistently.

This addresses that; as well as some minor changes to Gradle docs to improve consistency across the tasks, and corrects the builds so they trigger on changes to the mvn site contents.

Related issues

Have test cases been added to cover the new functionality?

N/A

@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 5, 2026
@chadlwilson chadlwilson changed the title Ensure OSS Index URL override is consistently documented docs: ensure OSS Index URL override is consistently documented Mar 5, 2026
Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
These docs are all duplicated - it makes it easier to keep them in sync if they have minimal different options.

- remove incorrect `retiredEnabled` option
- change formatting to be consistent

Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
- we generally want to run builds for markdown changes now; as we run `mvn site`.
- we also generally want to run for .txt changes as some are test files and other are licenses/notices included in built jars

Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
@jeremylong jeremylong added this to the 12.2.1 milestone Mar 5, 2026
Copy link
Collaborator

@jeremylong jeremylong left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@nhumblot nhumblot left a comment

Choose a reason for hiding this comment

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

praise: thank you for your help!

@nhumblot nhumblot merged commit 46fbdee into dependency-check:main Mar 6, 2026
16 checks passed
@chadlwilson chadlwilson deleted the fix-ossindex-docs branch March 7, 2026 02:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ant changes to ant cli changes to the cli documentation site documentation maven changes to the maven plugin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants