GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add blocking "auto-refresh" goal by kwin · Pull Request #1267 · apache/maven-site-plugin

Conversation

@kwin

@kwin kwin commented Apr 17, 2026

Copy link
Copy Markdown
Member

This re-renders modified Doxia sources automatically. Deprecate "run" goal in favour of this one.

This closes #1266

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

  • I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
  • In any other case, please file an Apache Individual Contributor License Agreement.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@kwin
Add blocking "hot-reload" goal
06f42b8 
This re-renders modified Doxia sources automatically.
Deprecate "run" goal in favour of this one.

This closes #1266
@kwin
kwin requested review from michael-o and olamy April 17, 2026 19:18
@michael-o

michael-o commented Apr 17, 2026

Copy link
Copy Markdown
Member

Will check next week.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
michael-o
michael-o reviewed Apr 20, 2026
View reviewed changes

@michael-o michael-o left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

What about reports? In 3.20.x I have made it possible to re-render reports, even external ones. Is it still the case here? Is the improvement not to have Jetty anymore? The asciidoctor plugin has a very similar feature, worth looking at and it never worked reliably for me.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java Resolved

Uh oh!

There was an error while loading. Please reload this page.
michael-o
michael-o requested changes Apr 26, 2026
View reviewed changes

@michael-o michael-o left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

So I went through the code and done some tests. The behavior is different compared to site:run. I would like to align this feature with https://docs.asciidoctor.org/maven-tools/latest/plugin/goals/auto-refresh/ calling it site:auto-refresh just consistency. I don't see how this fully replaces ´site:run, complement yes, replacement no. Moreover, site:run` gives you very detailed information on stuff it renders which is very helpful.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@kwin

kwin commented Apr 26, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

The behavior is different compared to site:run

What do you miss exactly?

site:run gives you very detailed information on stuff it renders which is very helpful.

What information is that exactly and isn't this also logged with this goal?

I would like to align this feature with https://docs.asciidoctor.org/maven-tools/latest/plugin/goals/auto-refresh/ calling it site:auto-refresh

I am fine with that.

Is the improvement not to have Jetty anymore?

Long term yes, having a Java Servlet Container just to serve static files is way to much overhead. Compare with #1240 and feel free to comment there. There were valid complaints from user's that m-site-p is too heavyweight in terms of dependencies and I agree with that.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@olamy

olamy commented Apr 27, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Is the improvement not to have Jetty anymore?

Long term yes, having a Java Servlet Container just to serve static files is way to much overhead. Compare with #1240 and feel free to comment there. There were valid complaints from user's that m-site-p is too heavyweight in terms of dependencies and I agree with that.

Agree too, using Jetty or any servlet container for static is a bit overengineering (and I'm a Jetty committer :)) or simply use com.sun.net.httpserver.HttpServer to reduce dependencies
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
olamy
olamy approved these changes Apr 27, 2026
View reviewed changes
@michael-o

michael-o commented May 1, 2026

Copy link
Copy Markdown
Member

The behavior is different compared to site:run

What do you miss exactly?

This one generates everything, given a large site with quite some reports will need time, the :run does on request.
Yet another issue is that Jetty is a HTTP server after all, it is much closer to the logic after deployment, especially with slash handing akin to mod_dir/mod_index.

site:run gives you very detailed information on stuff it renders which is very helpful.

What information is that exactly and isn't this also logged with this goal?

Please run it yourself, you will see all info: source, report, locale, very helpful.

I would like to align this feature with https://docs.asciidoctor.org/maven-tools/latest/plugin/goals/auto-refresh/ calling it site:auto-refresh

I am fine with that.

Is the improvement not to have Jetty anymore?

Long term yes, having a Java Servlet Container just to serve static files is way to much overhead. Compare with #1240 and feel free to comment there. There were valid complaints from user's that m-site-p is too heavyweight in terms of dependencies and I agree with that.

I agree that having the weight of a Servlet Container is bad, in fact we touched this topic with @hboutemy years ago and wanted to move it out to a maven-site-run-plugin, maybe it is about time.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@kwin
Rename from "hot-reload" to "auto-refresh"
4ee7b72 
No longer deprecate "site" goal.
@kwin

kwin commented May 11, 2026

Copy link
Copy Markdown
Member Author

I now removed the deprecation of run from this PR and also renamed the new goal name to auto-refresh.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@kwin
kwin requested a review from michael-o May 11, 2026 17:43
@kwin kwin changed the title Add blocking "hot-reload" goal Add blocking "auto-refresh" goal May 12, 2026
michael-o
michael-o requested changes May 13, 2026
View reviewed changes

@michael-o michael-o left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

A few more issues

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread src/main/java/org/apache/maven/plugins/site/render/AutoRefreshMojo.java Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread src/main/java/org/apache/maven/plugins/site/render/AutoRefreshMojo.java Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread src/main/java/org/apache/maven/plugins/site/render/AutoRefreshMojo.java Resolved

Uh oh!

There was an error while loading. Please reload this page.
@kwin
Fix additional PR comments
a798897
@michael-o
michael-o self-requested a review May 17, 2026 18:09
michael-o
michael-o approved these changes May 17, 2026
View reviewed changes

@michael-o michael-o left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Good to go!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
kwin added 2 commits May 17, 2026 20:12
@kwin
Improve error messages
093f082
@kwin
Improve goal description
3c1deb6
@kwin
kwin merged commit 93ecbb6 into master May 17, 2026
15 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@kwin
kwin deleted the feature/hot-reload branch May 17, 2026 19:33
@github-actions github-actions Bot added this to the 3.22.0 milestone May 17, 2026
@github-actions

github-actions Bot commented May 17, 2026

Copy link
Copy Markdown

@kwin Please assign appropriate label to PR according to the type of change.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot assigned kwin May 17, 2026
@kwin kwin added the enhancement New feature or request label May 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@olamy olamy olamy approved these changes
@michael-o michael-o michael-o approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@kwin kwin

Labels

enhancement New feature or request

Projects

None yet

Milestone

3.22.0

Development

Successfully merging this pull request may close these issues.

Provide "auto-refresh" goal which rerenders Doxia sources when modified

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@kwin @michael-o @olamy
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.