Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

wants to merge 1 commit into from

Conversation

@rohit-bhardwajj
Copy link

@rohit-bhardwajj rohit-bhardwajj commented Oct 7, 2025

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
Architectural refactor: updated plugin report output from *-mojo.html…
8d5a603 
… to *-goal.html across generation logic, integration tests, and documentation templates. Closes apache#949
@slawekjaranowski
Copy link
Member

slawekjaranowski commented Oct 7, 2025

@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 slawekjaranowski added enhancement New feature or request breaking Pull requests that break existing features labels Oct 7, 2025
@hboutemy
Copy link
Member

hboutemy commented Oct 9, 2025 •
edited
Loading

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 hboutemy changed the title Architectural refactor: updated plugin report output from *-mojo.html… Architectural refactor: rename *-mojo.html report output to goal Oct 10, 2025
@slawekjaranowski
Copy link
Member

slawekjaranowski commented Oct 20, 2025

please look at:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hboutemy hboutemy Awaiting requested review from hboutemy

Assignees

No one assigned

Labels

breaking Pull requests that break existing features enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

rename {goalname}-mojo.html to {goalname}-goal.html

3 participants

@rohit-bhardwajj @slawekjaranowski @hboutemy