maven-plugin-tools icon indicating copy to clipboard operation
maven-plugin-tools copied to clipboard

Architectural refactor: rename *-mojo.html report output to goal

Open rohit-bhardwajj opened this issue 2 months ago • 3 comments

This PR refactors the plugin report output logic to align with Maven goal terminology—changing generated filenames from *-mojo.html to *-goal.html.

Scope of changes:

  • Updated output filename logic in PluginReport.java and PluginOverviewRenderer.java
  • Adjusted integration test assertions across multiple verify.groovy files
  • Revised .apt site templates to reflect new goal-based naming
  • Ensured legacy references to "Mojo" remain where conceptually relevant

Verification:

  • Ran mvn verify successfully
  • Ran integration tests via mvn -Prun-its verify with all checks passing

Closes #949
Contributed as part of Hacktoberfest 🎉


✅ I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004

rohit-bhardwajj avatar Oct 07 '25 13:10 rohit-bhardwajj

@rohit-bhardwajj good works - thanks ....

@hboutemy But now I think that it is a good idea to change file names we need a same way to preserve old files with redirect to new one.

eg. when we search, eg on Google

maven plugin surefire test
maven plugin version set

We have a links to old files .... so need inform in some way search engines about such changes

I think we should preserve old html files with content like:

<html>
  <head>
   <meta http-equiv="refresh" content="0; URL=<new-file-name>" />    
  </head>
<html>

slawekjaranowski avatar Oct 07 '25 14:10 slawekjaranowski

I love the idea of this PR but yes, ideally, we have a transition from search engines: creating such redirect small pages looks like a good idea (with a flag in the plugin to disable that feature) this would also permit to remove the "breaking" change aspect: people upgrading would benefit from redirection before they take time to change the links to their goals doc

hboutemy avatar Oct 09 '25 22:10 hboutemy

please look at:

https://maven.apache.org/guides/plugin/guide-java-report-plugin-development.html#Creating_more_than_one_document

slawekjaranowski avatar Oct 20 '25 17:10 slawekjaranowski