You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

This page discusses emerging ideas of "clean up" of Maven project and it's related sub-projects.

General guidelines

Whenever you "touch" a project, would be good to perform following steps:

  • Make sure Plexus AbstractLogEnabled is not used (extended), Maven since 3.x uses SLF4J instead.
  • Make sure ancient org.codehaus.plexus:plexus-container-default is NOT used as dependency IN ANY SCOPE. In general, all shared components should be migrated to JSR330, while use of Plexus Container MAY BE still needed in UTs (due Plexus Components present in dependencies). Then use Sisu Plexus Shim instead (but only in test scope): org.eclipse.sisu:org.eclipse.sisu.plexus (currently 0.3.4, soon 1.0.0)
  • Make sure components in project use JSR330 annotations and not org.codehaus.plexus:plexus-component-annotations or EVEN WORSE, the Plexus QDox Javadoc annotations.
  • Drop use of Plexus Component Descriptor and org.codehaus.plexus:plexus-component-metadata plugin, and use org.eclipse.sisu:sisu-maven-plugin instead.

Maven

  • ... should really drop Maven 2.x support (was it 10 years?), so maven-compat must go.

Maven Artifact Transfer

  • this is widely used non-core, non-plugin, maybe "shared component". 
  • we need to keep it's "bridging" capability (see m-artifact-resolver 2.x plans, package renames again).
  • unsure about what we want with this: given planned rename, resolver API should not be used directly in upcoming code changes?

Maven Plugins

  • ... should really make up the 10 year lag, and stop depending on maven-compat stuff. Baseline for plugins should be Maven 3.1.x line.
  • We must forget the "ill fated" Maven 3.0.x line, not only due org.sonatype/org.eclipse Resolver problem (m-artifact-transfer kinda covers it), but also due it's "sealed" Plexus/Sisu implementation and ancient version. We must comprehend, that we have no resources to support 10+ years spanning compatibility. Move on.
  • (to be reviewed) mark Maven core dependencies as scope=provided

Maven SCM Cleanup

Maven SCM is bloated and contains many providers we cannot test, given they bridging for are non OSS SCMs. Proposal: keep only those SCM providers that are OSS in Maven project, and provide a clear path for SCM integrators. Propose plan:

Phase 1

  • mark as `@Deprecate` all except following providers: git (gitexe, jgit), svn (svnexe), mercurial
    • maven-scm-provider-accurev

    • maven-scm-provider-bazaar
    • maven-scm-provider-clearcase
    • maven-scm-provider-integrity
    • maven-scm-provider-jazz
    • maven-scm-provider-perforce
    • maven-scm-providers-cvs
    • maven-scm-providers-standard (skim POM)
    • maven-scm-provider-starteam
    • maven-scm-provider-synergy
    • maven-scm-provider-tfs
    • maven-scm-provider-vss
  • release as-is as next minor version

Phase 2 (post release)

  • drop all deprecated modules/providers (incuding svnkit)
  • up major version?
  • make it Java 8?
  • provide "clear path" (documentation, repository, mini-site?) for SCM integrators (prev codebase will be still available under release tag done in phase 1)
  • Get rid of Plexus DI


Maven Wagon

Similarly, Wagon contains many providers we have no feedback whatsoever, or, we do have feedback but are dead-end (JSch/SSH).

Phase 1

  • mark as `@Deprecate` all except following providers: file, http, ssh (sshexe), scm
  • release as-is as next minor version

Phase 2 (post release)

  • drop all deprecated modules/providers
  • up major version?
  • make it Java 8?
  • Wagon specific changes, like collapse DAV into HTTP (and drop webdav-jackrabbit), probably collapse http-shared into HTTP (as lightweight is gone as well)
  • Get rid of Plexus DI

Questions

  • if maven-compat goes away, how does Wagon fit/interface with Maven?


Maven Resolver

Phase 1

  • release 1.7.0 (soon): DONE (Java8 + locking)

Phase 2 (post release)

  • up major version (2.x)
  • Drop ServiceLocator, removes a lot of cruft and "default ctors"
  • make all things proper ctor injection and final (lot of code breakage)

Phase 3 (later)

  • Java package change from org.eclipse.aether to org.apache.maven.resolver?

Resolver and Maven

Maven version lineJava levelPlexus XMLSisu indexResolverLatest release
Java packageArtifact GAVersion
3.0.x1.5YesNoorg.sonatype.aetherorg.sonatype.aether:aether-api1.113.0.5, 2013-02-19
3.1.x1.5YesYesorg.eclipse.aetherorg.eclipse.aether:aether-api0.9.0.M23.1.1, 2013-09-17
3.2.x1.6YesYesorg.eclipse.aetherorg.eclipse.aether:aether-api1.0.0.v201405183.2.5, 2014-12-14
3.3.x1.7YesYesorg.eclipse.aetherorg.eclipse.aether:aether-api1.0.2.v201501143.3.9, 2015-11-10
3.5.x1.7YesYesorg.eclipse.aetherorg.apache.maven.resolver:maven-resolver-api1.1.13.5.7, 2018-06-14
3.6.x1.7YesYesorg.eclipse.aetherorg.apache.maven.resolver:maven-resolver-api1.4.13.6.3, 2019-11-19
3.8.x1.7YesYesorg.eclipse.aetherorg.apache.maven.resolver:maven-resolver-api1.6.33.8.2, 2021-08-04
4.x1.8YesYesorg.eclipse.aetherorg.apache.maven.resolver:maven-resolver-api2.x
5.x?No ?Yesorg.apache.maven.resolverorg.apache.maven.resolver:maven-resolver-api3.x

Maven Doxia Cleanup

Phase 1

  • mark as `@Deprecate` all except following providers: apt, markdown, asciidoc, xhtml, xhtml5
    • doxia-logging-api

    • doxia-module-confluence
    • doxia-module-docbook-simple
    • doxia-module-fml
    • doxia-module-fo
    • doxia-module-itext
    • doxia-module-latex
    • doxia-module-rtf
    • doxia-module-twiki
    • doxia-module-xdoc
    • doxia-test-docs (fml and xdoc only)


  • release as-is as next minor version

Phase 2 (post release)

  • drop all deprecated modules/providers
  • up major version?
  • make it Java 8?
  • Get rid of Plexus DI
  • Get rid of Doxia Logging


  • No labels