You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Michael Osipov <mi...@apache.org> on 2024/07/09 15:30:25 UTC

[HEADS UP] Maven Doxia 2.0.0 stack is coming

Dear Users, Reporting Plugin and Skin Maintainers,

for the past 2,5 years we have been working -- that is me (mostly) with 
Hervé Boutemy and Konrad Windszus -- on the modernization of the Doxia 
stack overcoming technical debts and open issues of the past ten years. 
After numerous milestones (10+) it has reached a very good maturity and 
stability to finally move to GA.

What is Maven Doxia anyway? It is the core document generation framework 
on which all Maven reporting plugins and the Maven Site Plugin are built 
upon. So when you invoke a standalone reporting goal or "mvn site" that 
stack is being used.
The involved components and reporting plugins from the Maven Core Team:
* maven-doxia
* maven-reporting-api
* maven-doxia-sitetools
* maven-reporting-impl
* maven-reporting-exec
* maven-site-plugin
* maven-fluido-skin
* maven-project-info-reports-plugin
* maven-plugin-tools (maven-plugin-reporting-plugin)
* maven-jxr (maven-jxr-plugin)
* maven-pmd-plugin
* maven-javadoc-plugin
* maven-checkstyle-plugin
* maven-help-plugin (uses API only)
* maven-surefire (maven-surefire-report-plugin)
* maven-dependency-plugin
* maven-invoker-plugin

Notes:
* Other reporting plugins we provide are not being upgraded
* Third party plugins need to be upgraded by their respective maintainers
* Components do have milestone versions until public evaluation has been 
completed

Also, please see this Confluence Wiki entry for more (technical) 
details: 
https://cwiki.apache.org/confluence/display/MAVEN/Towards+Doxia+2.0.0+Stack

What do you need to do?
* As a user you can build the reporting plugins from the prepared branch 
'doxia-2.0.0' or reach out to the third party maintainer to test his 
plugin against the updated stack.
* As a plugin maintainer you can start upgrading your plugin against the 
2.0.0 baseline in a separate branch. Look at the 'doxia-2.0.0' branch of 
our plugins to ease your work.
* As a skin maintainer you can start upgrading your skin against the 
2.0.0 baseline in a separate branch. Look at the master branch of the 
maven-fluido-skin. to ease your work.

Found problems, issues or have questions? Please report via users@ or 
dev@ mailing list (whichever makes most sense) and prepend "[DOXIA]" to 
the subject. I will try to respond timely.

Expectations:
* If you intend to mix and match components and plugins between both 
major versions (Doxia 1.x vs. Doxia 2.x) you must use the highest 
maven-site-plugin version, but don't expect everything to go smoothly.
* Not every issue or behavioral change is a regression. Some changes are 
deliberate. If they are not listed in the Confluence Wiki page, let me 
know, I will add them. But in any case, feel free to reach out.

Timeline:
* By mid of July I will give the the public (users and maintainers) at 
least 30 days (but no later than 2024-08-15) to review the changes in 
the stack, the 'doxia-2.0.0' branches, evaluate your plugin upgrade path 
and/or release new versions of plugins with old stack.
* By mid of August I will start merging the 'doxia-2.0.0' branches into 
every of our reporting plugins and perform the release procedure.
* After the reporting plugins from us (Maven Core Team) have been 
released I will again give the public at least 30 days (but no later 
than 2024-10-15) to review the upgraded and released plugins.
* If no issues are reported against components or plugins until mid of 
October I will move all Doxia stack milestone components to a GA version 
and release the reporting plugins with those GA versions.
* At least six or twelve months after that we might remove deprecated 
code from the Doxia 2.0.0 stack likely breaking code which worked 
transitionally.

Versioning:
Components have been bumped to new major versions. Plugin versions will 
remain on 3.x due to Maven 3 compatiblity. Their minor versions will be 
bumped. Maven Site Plugin 4 will be retained for future Maven 4, a new 
branch for Maven Site Plugin 3.x (likely 3.20.0) will be created and all 
changed will be merged into that branch. The current 3.x branch will be 
renamed to 3.12.x.

I hope to complete the GA release train by end of 2024 -- after more 
than three years!

Good luck,

Michael

Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Michael Osipov <mi...@apache.org>.
Am 2024-08-28 um 13:37 schrieb Sylwester Lachiewicz:
> Michael,
> 
> Is it worth updating our Maven Parent pom with released versions or should
> we wait until Doxia 2 GA?

For now, I would actually obstain and give the community at least a 
month to absorb new versions and report issues. As soon as I start 
releasing GA versions (end of September) I am good in upgrading to those 
Doxia 2 compatible versions.

Michael

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Sylwester Lachiewicz <sl...@gmail.com>.
Michael,

Is it worth updating our Maven Parent pom with released versions or should
we wait until Doxia 2 GA?

Sylwester

śr., 28 sie 2024, 13:21 użytkownik Michael Osipov <mi...@apache.org>
napisał:

> Am 2024-08-28 um 03:27 schrieb Basil Crow:
> > Hi Michael,
> >
> > Many thanks for your hard work on this stack over the past three
> > years. Is Maven Fluido Skin 2.0.0-M10 safe to adopt? I notice
> > Dependabot is not offering it because of its milestone status, but
> > Dependabot is offering Maven Site Plugin 3.20.0, which seems to
> > require a newer version of Maven Fluido Skin to avoid
> >
> >> [ERROR] Failed to execute goal
> org.apache.maven.plugins:maven-site-plugin:3.20.0:site (default-site) on
> project jellydoc-maven-plugin: Failed to create context for skin: Cannot
> use skin: has [1.11.1,2.0.0-M1) Doxia Sitetools prerequisite, but current
> is 2.0.0-M19
> >
> > Is there a plan to release a non-milestone version of Maven Fluido Skin?
>
> Please use 3.20.0 with Fluido Skin 2.0.0-M10. It will work.
>
> According to my plan the GA versions are about to be released from end
> of September. See the timeline in the headsup annoucement.
>
> Michael
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>

Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Michael Osipov <mi...@apache.org>.
Am 2024-08-28 um 03:27 schrieb Basil Crow:
> Hi Michael,
> 
> Many thanks for your hard work on this stack over the past three
> years. Is Maven Fluido Skin 2.0.0-M10 safe to adopt? I notice
> Dependabot is not offering it because of its milestone status, but
> Dependabot is offering Maven Site Plugin 3.20.0, which seems to
> require a newer version of Maven Fluido Skin to avoid
> 
>> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.20.0:site (default-site) on project jellydoc-maven-plugin: Failed to create context for skin: Cannot use skin: has [1.11.1,2.0.0-M1) Doxia Sitetools prerequisite, but current is 2.0.0-M19
> 
> Is there a plan to release a non-milestone version of Maven Fluido Skin?

Please use 3.20.0 with Fluido Skin 2.0.0-M10. It will work.

According to my plan the GA versions are about to be released from end 
of September. See the timeline in the headsup annoucement.

Michael

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Basil Crow <me...@basilcrow.com>.
Hi Michael,

Many thanks for your hard work on this stack over the past three
years. Is Maven Fluido Skin 2.0.0-M10 safe to adopt? I notice
Dependabot is not offering it because of its milestone status, but
Dependabot is offering Maven Site Plugin 3.20.0, which seems to
require a newer version of Maven Fluido Skin to avoid

> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.20.0:site (default-site) on project jellydoc-maven-plugin: Failed to create context for skin: Cannot use skin: has [1.11.1,2.0.0-M1) Doxia Sitetools prerequisite, but current is 2.0.0-M19

Is there a plan to release a non-milestone version of Maven Fluido Skin?

Thanks,
Basil

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Michael Osipov <mi...@apache.org>.
Am 2024-08-28 um 18:59 schrieb Matt Nelson:
>> * Other reporting plugins we provide are not being upgraded
> 
> Are those other plugins no longer supported by the Maven team?
> Looking at https://maven.apache.org/plugins/
> The changelog, changes, and linkcheck plugins look to be the only three
> reporting plugins not being upgraded.

That is correct. In fact, regarding the Changes Plugin I have written a 
lengthly mail to the dev@ mailing list and what's wrong with it. No one 
stood up to volunteer to move to it Doxia 2.0.0. The other two have been 
dead already. We just need to make it official which -- again -- needs time.

Michael

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Matt Nelson <th...@gmail.com>.
> * Other reporting plugins we provide are not being upgraded

Are those other plugins no longer supported by the Maven team?
Looking at https://maven.apache.org/plugins/
The changelog, changes, and linkcheck plugins look to be the only three
reporting plugins not being upgraded.

On Tue, Jul 9, 2024 at 10:30 AM Michael Osipov <mi...@apache.org> wrote:

> Dear Users, Reporting Plugin and Skin Maintainers,
>
> for the past 2,5 years we have been working -- that is me (mostly) with
> Hervé Boutemy and Konrad Windszus -- on the modernization of the Doxia
> stack overcoming technical debts and open issues of the past ten years.
> After numerous milestones (10+) it has reached a very good maturity and
> stability to finally move to GA.
>
> What is Maven Doxia anyway? It is the core document generation framework
> on which all Maven reporting plugins and the Maven Site Plugin are built
> upon. So when you invoke a standalone reporting goal or "mvn site" that
> stack is being used.
> The involved components and reporting plugins from the Maven Core Team:
> * maven-doxia
> * maven-reporting-api
> * maven-doxia-sitetools
> * maven-reporting-impl
> * maven-reporting-exec
> * maven-site-plugin
> * maven-fluido-skin
> * maven-project-info-reports-plugin
> * maven-plugin-tools (maven-plugin-reporting-plugin)
> * maven-jxr (maven-jxr-plugin)
> * maven-pmd-plugin
> * maven-javadoc-plugin
> * maven-checkstyle-plugin
> * maven-help-plugin (uses API only)
> * maven-surefire (maven-surefire-report-plugin)
> * maven-dependency-plugin
> * maven-invoker-plugin
>
> Notes:
> * Other reporting plugins we provide are not being upgraded
> * Third party plugins need to be upgraded by their respective maintainers
> * Components do have milestone versions until public evaluation has been
> completed
>
> Also, please see this Confluence Wiki entry for more (technical)
> details:
> https://cwiki.apache.org/confluence/display/MAVEN/Towards+Doxia+2.0.0+Stack
>
> What do you need to do?
> * As a user you can build the reporting plugins from the prepared branch
> 'doxia-2.0.0' or reach out to the third party maintainer to test his
> plugin against the updated stack.
> * As a plugin maintainer you can start upgrading your plugin against the
> 2.0.0 baseline in a separate branch. Look at the 'doxia-2.0.0' branch of
> our plugins to ease your work.
> * As a skin maintainer you can start upgrading your skin against the
> 2.0.0 baseline in a separate branch. Look at the master branch of the
> maven-fluido-skin. to ease your work.
>
> Found problems, issues or have questions? Please report via users@ or
> dev@ mailing list (whichever makes most sense) and prepend "[DOXIA]" to
> the subject. I will try to respond timely.
>
> Expectations:
> * If you intend to mix and match components and plugins between both
> major versions (Doxia 1.x vs. Doxia 2.x) you must use the highest
> maven-site-plugin version, but don't expect everything to go smoothly.
> * Not every issue or behavioral change is a regression. Some changes are
> deliberate. If they are not listed in the Confluence Wiki page, let me
> know, I will add them. But in any case, feel free to reach out.
>
> Timeline:
> * By mid of July I will give the the public (users and maintainers) at
> least 30 days (but no later than 2024-08-15) to review the changes in
> the stack, the 'doxia-2.0.0' branches, evaluate your plugin upgrade path
> and/or release new versions of plugins with old stack.
> * By mid of August I will start merging the 'doxia-2.0.0' branches into
> every of our reporting plugins and perform the release procedure.
> * After the reporting plugins from us (Maven Core Team) have been
> released I will again give the public at least 30 days (but no later
> than 2024-10-15) to review the upgraded and released plugins.
> * If no issues are reported against components or plugins until mid of
> October I will move all Doxia stack milestone components to a GA version
> and release the reporting plugins with those GA versions.
> * At least six or twelve months after that we might remove deprecated
> code from the Doxia 2.0.0 stack likely breaking code which worked
> transitionally.
>
> Versioning:
> Components have been bumped to new major versions. Plugin versions will
> remain on 3.x due to Maven 3 compatiblity. Their minor versions will be
> bumped. Maven Site Plugin 4 will be retained for future Maven 4, a new
> branch for Maven Site Plugin 3.x (likely 3.20.0) will be created and all
> changed will be merged into that branch. The current 3.x branch will be
> renamed to 3.12.x.
>
> I hope to complete the GA release train by end of 2024 -- after more
> than three years!
>
> Good luck,
>
> Michael
>

Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Michael Osipov <mi...@apache.org>.
https://www.mail-archive.com/users@maven.apache.org/msg146091.html

On 2024/10/16 21:44:40 Basil Crow wrote:
> I have successfully upgraded the Jenkins Stapler and Jellydoc Maven
> plugins to the Doxia 2.0.0 stack, using Maven Reporting API 4.0.0,
> Maven Reporting Impl 4.0.0, and Maven Fluido Skin 2.0.0-M11. Thank you
> very much! The only remaining question I have is about this warning:
> 
> [WARNING] Site model of
> 'org.jenkins-ci.tools:maven-hpi-plugin:maven-plugin:3.60-SNAPSHOT' for
> default locale is still using the old pre-version 2.0.0 model. You
> MUST migrate to the new model as soon as possible otherwise your build
> will break in the future!
> 
> How do I migrate to the new model? I read
> https://maven.apache.org/plugins/maven-site-plugin/migrate.html but
> did not see anything there that was relevant to my use case. I could
> not find any other documentation or examples about how to perform this
> migration.
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
> 
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Basil Crow <me...@basilcrow.com>.
I have successfully upgraded the Jenkins Stapler and Jellydoc Maven
plugins to the Doxia 2.0.0 stack, using Maven Reporting API 4.0.0,
Maven Reporting Impl 4.0.0, and Maven Fluido Skin 2.0.0-M11. Thank you
very much! The only remaining question I have is about this warning:

[WARNING] Site model of
'org.jenkins-ci.tools:maven-hpi-plugin:maven-plugin:3.60-SNAPSHOT' for
default locale is still using the old pre-version 2.0.0 model. You
MUST migrate to the new model as soon as possible otherwise your build
will break in the future!

How do I migrate to the new model? I read
https://maven.apache.org/plugins/maven-site-plugin/migrate.html but
did not see anything there that was relevant to my use case. I could
not find any other documentation or examples about how to perform this
migration.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Michael Osipov <mi...@apache.org>.
Am 2024-09-01 um 22:01 schrieb Basil Crow:
> I am pleased to report that I successfully tested the upgrade path in
> jellydoc-maven-plugin and stapler-maven-plugin using Maven Reporting
> Impl 4.0.0-M15 and Maven Fluido Skin 2.0.0-M10. The only change I had
> to make was removing the (deprecated)
> org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink,
> Locale) override in my subclasses. After that change, my plugins
> compiled, and automated and manual testing was successful. Thank you
> very much!
> 
> The only minor inconvenience I noticed during this process was
> Enforcer errors for plexus-utils:
> 
> [ERROR] Require upper bound dependencies error for
> org.codehaus.plexus:plexus-utils:3.5.1 paths to dependency are:
> [ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
> [ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
> [ERROR]     +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
> org.codehaus.plexus:plexus-utils:4.0.1
> [ERROR] and
> [ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
> [ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
> [ERROR]     +-org.apache.maven.doxia:doxia-site-model:2.0.0-M19
> [ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
> org.codehaus.plexus:plexus-utils:4.0.1
> [ERROR] and
> [ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
> [ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
> [ERROR]     +-org.apache.maven.doxia:doxia-core:2.0.0-M12
> [ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
> org.codehaus.plexus:plexus-utils:3.5.1
> [ERROR] and
> [ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
> [ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
> [ERROR]     +-org.apache.maven.doxia:doxia-integration-tools:2.0.0-M19
> [ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
> org.codehaus.plexus:plexus-utils:4.0.1
> [ERROR] and
> [ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
> [ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
> [ERROR]     +-org.apache.maven.doxia:doxia-site-renderer:2.0.0-M19
> [ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
> org.codehaus.plexus:plexus-utils:4.0.1
> 
> My plugins have a Maven baseline of 3.8.1, so I cannot use
> plexus-utils 4. It would be nice if Maven Reporting Impl 4.x didn't
> generate these Enforcer errors when used in a plugin that targets
> Maven 3.8.1.

I think that we use Plexus Utils 4.0.1 and Plexus XML 3.0.1 everywhere. 
I will write a note and go through the POMs before I will do the next 
releases end of month.

M

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: [HEADS UP] Maven Doxia 2.0.0 stack is coming

Posted by Basil Crow <me...@basilcrow.com>.
I am pleased to report that I successfully tested the upgrade path in
jellydoc-maven-plugin and stapler-maven-plugin using Maven Reporting
Impl 4.0.0-M15 and Maven Fluido Skin 2.0.0-M10. The only change I had
to make was removing the (deprecated)
org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink,
Locale) override in my subclasses. After that change, my plugins
compiled, and automated and manual testing was successful. Thank you
very much!

The only minor inconvenience I noticed during this process was
Enforcer errors for plexus-utils:

[ERROR] Require upper bound dependencies error for
org.codehaus.plexus:plexus-utils:3.5.1 paths to dependency are:
[ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
[ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
[ERROR]     +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
org.codehaus.plexus:plexus-utils:4.0.1
[ERROR] and
[ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
[ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
[ERROR]     +-org.apache.maven.doxia:doxia-site-model:2.0.0-M19
[ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
org.codehaus.plexus:plexus-utils:4.0.1
[ERROR] and
[ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
[ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
[ERROR]     +-org.apache.maven.doxia:doxia-core:2.0.0-M12
[ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
org.codehaus.plexus:plexus-utils:3.5.1
[ERROR] and
[ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
[ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
[ERROR]     +-org.apache.maven.doxia:doxia-integration-tools:2.0.0-M19
[ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
org.codehaus.plexus:plexus-utils:4.0.1
[ERROR] and
[ERROR] +-io.jenkins.tools.maven:jellydoc-maven-plugin:999999-SNAPSHOT
[ERROR]   +-org.apache.maven.reporting:maven-reporting-impl:4.0.0-M15
[ERROR]     +-org.apache.maven.doxia:doxia-site-renderer:2.0.0-M19
[ERROR]       +-org.codehaus.plexus:plexus-utils:3.5.1 (managed) <--
org.codehaus.plexus:plexus-utils:4.0.1

My plugins have a Maven baseline of 3.8.1, so I cannot use
plexus-utils 4. It would be nice if Maven Reporting Impl 4.x didn't
generate these Enforcer errors when used in a plugin that targets
Maven 3.8.1.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org