You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/10/07 20:39:02 UTC

(maven-shared-utils) 01/01: Scope the logging deprecation to plugins that require Maven 3.10

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch agent/logging-deprecation-scope
in repository https://gitbox.apache.org/repos/asf/maven-shared-utils.git

commit 1c771adb32c9b3ab7beffc3208f41ea2dc27f4f6
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Wed Oct 7 22:38:52 2026 +0200

    Scope the logging deprecation to plugins that require Maven 3.10
    
    The replacement, MessageBuilderFactory, exists only from Maven 3.10.0, while
    the plugin minimum is 3.9.0. Plugins below 3.10 should keep using this
    package; do not reword this back into an unconditional "use X instead".
---
 .../org/apache/maven/shared/utils/logging/AnsiMessageBuilder.java   | 6 ++++--
 .../org/apache/maven/shared/utils/logging/LoggerLevelRenderer.java  | 6 ++++--
 .../java/org/apache/maven/shared/utils/logging/MessageBuilder.java  | 6 ++++--
 .../java/org/apache/maven/shared/utils/logging/MessageUtils.java    | 6 ++++--
 .../org/apache/maven/shared/utils/logging/PlainMessageBuilder.java  | 6 ++++--
 src/main/java/org/apache/maven/shared/utils/logging/Style.java      | 6 ++++--
 .../java/org/apache/maven/shared/utils/logging/package-info.java    | 5 +++++
 7 files changed, 29 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuilder.java b/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuilder.java
index c7796e8..96dd35b 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuilder.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuilder.java
@@ -24,8 +24,10 @@ import org.fusesource.jansi.Ansi;
  * Message builder implementation that supports ANSI colors through
  * <a href="http://fusesource.github.io/jansi/">Jansi</a> with configurable styles through {@link Style}.
  *
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 class AnsiMessageBuilder implements MessageBuilder, LoggerLevelRenderer {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/LoggerLevelRenderer.java b/src/main/java/org/apache/maven/shared/utils/logging/LoggerLevelRenderer.java
index d0d3719..8558223 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/LoggerLevelRenderer.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/LoggerLevelRenderer.java
@@ -23,8 +23,10 @@ package org.apache.maven.shared.utils.logging;
  * logger level.
  *
  * @since 3.2.0
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 public interface LoggerLevelRenderer {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/MessageBuilder.java b/src/main/java/org/apache/maven/shared/utils/logging/MessageBuilder.java
index 59eb269..63c368b 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/MessageBuilder.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/MessageBuilder.java
@@ -28,8 +28,10 @@ import java.util.Formatter;
  *
  * @see MessageUtils
  * @since 3.1.0
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 public interface MessageBuilder {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java b/src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java
index 0cd4e11..6c2f571 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java
@@ -30,8 +30,10 @@ import org.fusesource.jansi.AnsiMode;
  * <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI colors</a> on any platform.
  *
  * @since 3.1.0
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 public class MessageUtils {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuilder.java b/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuilder.java
index d6c37ee..a9b0b5c 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuilder.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuilder.java
@@ -21,8 +21,10 @@ package org.apache.maven.shared.utils.logging;
 /**
  * Message builder implementation that just ignores styling, for Maven version earlier than 3.5.0.
  *
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 class PlainMessageBuilder implements MessageBuilder, LoggerLevelRenderer {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/Style.java b/src/main/java/org/apache/maven/shared/utils/logging/Style.java
index c18086f..1f7996d 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/Style.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/Style.java
@@ -27,8 +27,10 @@ import org.fusesource.jansi.Ansi.Color;
  * Configurable message styles.
  *
  * @since 3.1.0
- * @deprecated use {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
- *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) instead
+ * @deprecated migrate to {@code org.apache.maven.message.MessageBuilderFactory} (Maven 3.10.0 and later)
+ *             or {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4) once your
+ *             plugin or extension requires one of those Maven versions. Until then, keep using
+ *             this API; it remains supported.
  */
 @Deprecated
 enum Style {
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/package-info.java b/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
index e97d701..0fc198f 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
@@ -30,6 +30,11 @@
  * Plugins can use this API with any Maven version: color
  * just won't be activated when run with Maven versions older than 3.5.0.
  * <p>
+ * This package is deprecated in favor of {@code org.apache.maven.message.MessageBuilderFactory}
+ * (Maven 3.10.0 and later) and {@code org.apache.maven.api.services.MessageBuilderFactory} (Maven 4).
+ * The deprecation only applies once a plugin or extension requires one of those Maven versions:
+ * code that still supports older Maven versions should keep using this package.
+ * <p>
  * Styles are:<ul>
  * <li><code>debug</code>, <code>info</code>, <code>warning</code> and <code>error</code> for
  * logger level rendering,</li>