Skip to content

docs: remove automatic developer-focused maven info/reports from documentation site - #8798

Open
chadlwilson wants to merge 7 commits into
dependency-check:mainfrom
chadlwilson:remove-maven-publish-metadata
Open

chadlwilson wants to merge 7 commits into
dependency-check:mainfrom
chadlwilson:remove-maven-publish-metadata

Conversation

@chadlwilson

@chadlwilson chadlwilson commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

Description of Change

As discussed at #8353 this simplifies the build.and our ODC documentation by removing all of the dev-focused HTML reports from the published documentation website.

Consequences

  • no longer need to compile code, run tests etc to consistently generate the docs since they no longer include test reports, annotated source etc
  • less complex relationship between maven lifecycle for multi-module, reporting and site generation
  • faster build, probably makes parallel build possible (later)

Testing

  • Compared the generated target/staging folder contents before/after and looks fine to me.
  • Visually checked all the main pages in the generated site.

Minor related changes

  • fixed/updated some links in the "Related Work" section
  • tidied site descriptors to latest schema version/UTF-8
  • updated copyright years and names to be consistent

Related issues

Have test cases been added to cover the new functionality?

yes

Additional info

Ignoring the files with only the removed 3 lines of menu items, the diff is:

$ diff -ru before after | diffstat | grep -v '|    3'
 after/dependency-check-core/index.html                              |    4
 after/dependency-check-maven/configuration.html                     |   24 ++---
 after/dependency-check-maven/plugin-info.html                       |   16 ---
 after/dependency-check-maven/project-reports.html                   |   46 ----------
 after/dependency-check-utils/index.html                             |    7 -
 after/related.html                                                  |   25 ++---
 before/checkstyle-aggregate.html                                    |only
 before/checkstyle.html                                              |only
 before/ci-management.html                                           |only
 before/dependency-check-ant/apidocs                                 |only
 before/dependency-check-ant/checkstyle.html                         |only
 before/dependency-check-ant/ci-management.html                      |only
 before/dependency-check-ant/dependency-analysis.html                |only
 before/dependency-check-ant/dependency-updates-report.html          |only
 before/dependency-check-ant/issue-management.html                   |only
 before/dependency-check-ant/licenses.html                           |only
 before/dependency-check-ant/plugin-updates-report.html              |only
 before/dependency-check-ant/project-info.html                       |only
 before/dependency-check-ant/project-reports.html                    |only
 before/dependency-check-ant/scm.html                                |only
 before/dependency-check-ant/spotbugs.html                           |only
 before/dependency-check-ant/summary.html                            |only
 before/dependency-check-ant/surefire.html                           |only
 before/dependency-check-ant/taglist.html                            |only
 before/dependency-check-ant/team.html                               |only
 before/dependency-check-ant/xref                                    |only
 before/dependency-check-ant/xref-test                               |only
 before/dependency-check-cli/apidocs                                 |only
 before/dependency-check-cli/checkstyle.html                         |only
 before/dependency-check-cli/ci-management.html                      |only
 before/dependency-check-cli/dependency-analysis.html                |only
 before/dependency-check-cli/dependency-updates-report.html          |only
 before/dependency-check-cli/issue-management.html                   |only
 before/dependency-check-cli/licenses.html                           |only
 before/dependency-check-cli/plugin-updates-report.html              |only
 before/dependency-check-cli/project-info.html                       |only
 before/dependency-check-cli/project-reports.html                    |only
 before/dependency-check-cli/scm.html                                |only
 before/dependency-check-cli/spotbugs.html                           |only
 before/dependency-check-cli/summary.html                            |only
 before/dependency-check-cli/surefire.html                           |only
 before/dependency-check-cli/taglist.html                            |only
 before/dependency-check-cli/team.html                               |only
 before/dependency-check-cli/xref                                    |only
 before/dependency-check-cli/xref-test                               |only
 before/dependency-check-core/apidocs                                |only
 before/dependency-check-core/checkstyle.html                        |only
 before/dependency-check-core/ci-management.html                     |only
 before/dependency-check-core/dependency-analysis.html               |only
 before/dependency-check-core/dependency-updates-report.html         |only
 before/dependency-check-core/issue-management.html                  |only
 before/dependency-check-core/licenses.html                          |only
 before/dependency-check-core/plugin-updates-report.html             |only
 before/dependency-check-core/project-info.html                      |only
 before/dependency-check-core/project-reports.html                   |only
 before/dependency-check-core/scm.html                               |only
 before/dependency-check-core/spotbugs.html                          |only
 before/dependency-check-core/summary.html                           |only
 before/dependency-check-core/surefire.html                          |only
 before/dependency-check-core/taglist.html                           |only
 before/dependency-check-core/team.html                              |only
 before/dependency-check-core/xref                                   |only
 before/dependency-check-core/xref-test                              |only
 before/dependency-check-maven/apidocs                               |only
 before/dependency-check-maven/checkstyle.html                       |only
 before/dependency-check-maven/ci-management.html                    |only
 before/dependency-check-maven/dependency-analysis.html              |only
 before/dependency-check-maven/dependency-updates-report.html        |only
 before/dependency-check-maven/issue-management.html                 |only
 before/dependency-check-maven/licenses.html                         |only
 before/dependency-check-maven/plugin-updates-report.html            |only
 before/dependency-check-maven/project-info.html                     |only
 before/dependency-check-maven/scm.html                              |only
 before/dependency-check-maven/spotbugs.html                         |only
 before/dependency-check-maven/summary.html                          |only
 before/dependency-check-maven/surefire.html                         |only
 before/dependency-check-maven/taglist.html                          |only
 before/dependency-check-maven/team.html                             |only
 before/dependency-check-maven/xref                                  |only
 before/dependency-check-maven/xref-test                             |only
 before/dependency-check-plugin/checkstyle.html                      |only
 before/dependency-check-plugin/ci-management.html                   |only
 before/dependency-check-plugin/dependency-analysis.html             |only
 before/dependency-check-plugin/dependency-updates-report.html       |only
 before/dependency-check-plugin/issue-management.html                |only
 before/dependency-check-plugin/licenses.html                        |only
 before/dependency-check-plugin/plugin-updates-report.html           |only
 before/dependency-check-plugin/project-info.html                    |only
 before/dependency-check-plugin/project-reports.html                 |only
 before/dependency-check-plugin/scm.html                             |only
 before/dependency-check-plugin/summary.html                         |only
 before/dependency-check-plugin/surefire.html                        |only
 before/dependency-check-plugin/team.html                            |only
 before/dependency-check-utils/apidocs                               |only
 before/dependency-check-utils/checkstyle.html                       |only
 before/dependency-check-utils/ci-management.html                    |only
 before/dependency-check-utils/dependency-analysis.html              |only
 before/dependency-check-utils/dependency-updates-report.html        |only
 before/dependency-check-utils/issue-management.html                 |only
 before/dependency-check-utils/licenses.html                         |only
 before/dependency-check-utils/plugin-updates-report.html            |only
 before/dependency-check-utils/project-info.html                     |only
 before/dependency-check-utils/project-reports.html                  |only
 before/dependency-check-utils/scm.html                              |only
 before/dependency-check-utils/spotbugs.html                         |only
 before/dependency-check-utils/summary.html                          |only
 before/dependency-check-utils/surefire.html                         |only
 before/dependency-check-utils/taglist.html                          |only
 before/dependency-check-utils/team.html                             |only
 before/dependency-check-utils/xref                                  |only
 before/dependency-check-utils/xref-test                             |only
 before/dependency-updates-report.html                               |only
 before/issue-management.html                                        |only
 before/licenses.html                                                |only
 before/modules.html                                                 |only
 before/plugin-updates-report.html                                   |only
 before/project-info.html                                            |only
 before/project-reports.html                                         |only
 before/scm.html                                                     |only
 before/summary.html                                                 |only
 before/surefire.html                                                |only
 before/team.html                                                    |only
 before/xref                                                         |only
 before/xref-test                                                    |only

Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
@chadlwilson chadlwilson changed the title docs: remove maven-generated developer-fcused reports from documentation site docs: remove automatic developer-focused maven info/reports from documentation site Sep 15, 2026
@chadlwilson chadlwilson added the documentation site documentation label Sep 15, 2026
@chadlwilson
chadlwilson force-pushed the remove-maven-publish-metadata branch from 5bc3e19 to 8f5db67 Compare September 15, 2026 15:34
@boring-cyborg boring-cyborg Bot added ant changes to ant cli changes to the cli core changes to core maven changes to the maven plugin utils changes to utils labels Sep 15, 2026
@chadlwilson
chadlwilson requested a balanced review from Copilot September 15, 2026 15:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Plugin reporting still compiles code, and the new SpotBugs filter path breaks module-local Maven builds.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Simplifies documentation generation by removing developer-focused Maven reports while retaining user-facing plugin documentation.

Changes:

  • Disables most Maven-generated site reports.
  • Updates site descriptors, encoding, and documentation links.
  • Simplifies build configuration and updates several plugin versions.
File summaries
File Description
pom.xml Removes reporting infrastructure and simplifies site generation.
maven/pom.xml Retains Maven plugin goal reports.
src/main/config/version-rules.xml Removes obsolete version rules.
src/site/site.xml Updates schema and removes report navigation.
src/site/markdown/related.md Refreshes related-project links.
maven/src/site/site.xml Removes report navigation.
maven/src/site/markdown/configuration.md Modernizes an XML example.
utils/src/site/site.xml Modernizes the descriptor and menu.
core/src/site/site.xml Modernizes the descriptor and menu.
cli/src/site/site.xml Modernizes the descriptor and removes reports.
archetype/src/site/site.xml Modernizes the descriptor and removes reports.
ant/src/site/site.xml Modernizes the descriptor and removes reports.
Review details
  • Files reviewed: 12/12 changed files
  • Comments generated: 2
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread pom.xml
Comment thread maven/pom.xml
@chadlwilson
chadlwilson force-pushed the remove-maven-publish-metadata branch from 8f5db67 to 5ec578b Compare September 15, 2026 15:58
@chadlwilson
chadlwilson requested a balanced review from Copilot September 15, 2026 15:59
…n site

As discussed at dependency-check#8353 these maven-generated reports no longer
serve a useful purpose, and are mainly developer-oriented rather than user oriented, so have been removed from the published sites.
A notable exception is the mechanism to generate the reports for the maven plugin; whose plugin-related subset are maintained.

Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
@chadlwilson
chadlwilson force-pushed the remove-maven-publish-metadata branch from 5ec578b to 36f6a1f Compare September 15, 2026 16:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The reporting removal is internally consistent and preserves the required Maven plugin documentation.

Review details
  • Files reviewed: 12/13 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

@marcelstoer marcelstoer left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice job, thanks a lot!

Comment thread src/site/site.xml Outdated
Comment thread src/site/site.xml Outdated
Comment thread src/site/site.xml Outdated
Comment thread ant/src/site/site.xml Outdated
Co-authored-by: Jeremy Long <jeremy.long@gmail.com>
Comment thread src/site/site.xml Outdated
Comment thread archetype/src/site/site.xml Outdated
Comment thread cli/src/site/site.xml Outdated
Comment thread core/src/site/site.xml Outdated
Comment thread maven/src/site/site.xml Outdated
Comment thread utils/src/site/site.xml Outdated
Co-authored-by: Jeremy Long <jeremy.long@gmail.com>
Comment thread src/site/site.xml Outdated
The base copyright cites "OWASP Dependency-Check Contributors" but is inconsistent in other places. Since many files have individual Copyright headers, this is probably the only consistent way to do it.

Signed-off-by: Chad Wilson <29788154+chadlwilson@users.noreply.github.com>
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 core changes to core documentation site documentation maven changes to the maven plugin utils changes to utils

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants