#979: overhaul of the updates logger; added json and csv + a new appendable xml which records multiple executions

Added changeRecorder to display-property-updates, display-parent-updates, display-dependency-updates, display-extension-updates, display-plugin-updates;
Added changeRecorder to display-property-updates, display-parent-updates, display-dependency-updates, display-extension-updates

Author: andrzejj0

.gitignore

@@ -7,3 +7,4 @@ target
 .vscode
 .checkstyle
 /.factorypath
+/hs_err_pid*.log

pom.xml

@@ -148,6 +148,17 @@
     <invoker.parallelThreads>0.75C</invoker.parallelThreads>
     <!-- mono-module doesn't require site:stage for scm-publish -->
     <project.build.outputTimestamp>2025-09-22T06:07:04Z</project.build.outputTimestamp>
+
+    <!-- dependencies for version changes model -->
+    <jaxbApi.version>2.3.1</jaxbApi.version>
+    <jaxbRuntime.version>2.3.9</jaxbRuntime.version>
+    <jacksonDatabind.version>2.20.0</jacksonDatabind.version>
+    <jacksonDataformatXml.version>2.20.0</jacksonDataformatXml.version>
+    <jaxb2MavenPlugin.version>2.5.0</jaxb2MavenPlugin.version>
+    <jaxb2FluentApi.version>3.0</jaxb2FluentApi.version>
+    <jaxb2BasicsAnnotate.version>1.1.0</jaxb2BasicsAnnotate.version>
+    <jacksonDataformatCsv.version>2.17.2</jacksonDataformatCsv.version>
+    <jacksonDatatypeJsr310.version>2.19.0</jacksonDatatypeJsr310.version>
   </properties>
 
   <dependencyManagement>
@@ -388,6 +399,37 @@
         <artifactId>wagon-provider-api</artifactId>
         <version>3.5.3</version>
       </dependency>
+      <dependency>
+        <groupId>org.glassfish.jaxb</groupId>
+        <artifactId>jaxb-runtime</artifactId>
+        <version>${jaxbRuntime.version}</version>
+        <scope>runtime</scope>
+      </dependency>
+      <dependency>
+        <groupId>com.fasterxml.jackson.core</groupId>
+        <artifactId>jackson-databind</artifactId>
+        <version>${jacksonDatabind.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>com.fasterxml.jackson.dataformat</groupId>
+        <artifactId>jackson-dataformat-xml</artifactId>
+        <version>${jacksonDataformatXml.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>javax.xml.bind</groupId>
+        <artifactId>jaxb-api</artifactId>
+        <version>${jaxbApi.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>com.fasterxml.jackson.dataformat</groupId>
+        <artifactId>jackson-dataformat-csv</artifactId>
+        <version>${jacksonDataformatCsv.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>com.fasterxml.jackson.datatype</groupId>
+        <artifactId>jackson-datatype-jsr310</artifactId>
+        <version>${jacksonDatatypeJsr310.version}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

versions-api/pom.xml

@@ -12,6 +12,19 @@
   <name>Versions API</name>
   <description>Extension API for Versions Plugin</description>
 
+  <dependencies>
+    <dependency>
+      <groupId>org.codehaus.mojo.versions</groupId>
+      <artifactId>versions-model</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-core</artifactId>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+
   <reporting>
     <plugins>
       <plugin>

versions-api/src/main/java/org/codehaus/mojo/versions/api/change/DependencyVersionChange.java

@@ -22,7 +22,9 @@
  *
  * @author Slawomir Jaranowski
  * @since 2.14.0
+ * @deprecated use classes from {@code versions-model}
  */
+@Deprecated
 public interface DependencyVersionChange extends VersionChange {
     /**
      * Returns the groupId of the dependency

versions-api/src/main/java/org/codehaus/mojo/versions/api/change/PropertyVersionChange.java

@@ -22,7 +22,9 @@
  *
  * @author Andrzej Jarmoniuk
  * @since 2.15.0
+ * @deprecated use classes from {@code versions-model}
  */
+@Deprecated
 public interface PropertyVersionChange extends VersionChange {
 
     /**

versions-api/src/main/java/org/codehaus/mojo/versions/api/recording/ChangeRecord.java

@@ -25,7 +25,9 @@
  * @author Slawomir Jaranowski
  * @since 2.14.0
  * @param <T> concrete {@link VersionChange} sub-interface
+ * @deprecated use classes from {@code versions-model}
  */
+@Deprecated
 public interface ChangeRecord<T extends VersionChange> {
     /**
      * Returns the details about changed item

versions-api/src/main/java/org/codehaus/mojo/versions/api/recording/ChangeRecorder.java

@@ -25,7 +25,9 @@
  *
  * @author Slawomir Jaranowski
  * @since 2.14.0
+ * @deprecated use {@link VersionChangeRecorder} and {@code versions-model}
  */
+@Deprecated
 public interface ChangeRecorder {
     /**
      * Record that a dependency was updated.

versions-api/src/main/java/org/codehaus/mojo/versions/api/recording/DependencyChangeRecord.java

@@ -24,7 +24,9 @@
  *
  * @author Slawomir Jaranowski
  * @since 2.14.0
+ * @deprecated use classes from {@code versions-model}
  */
+@Deprecated
 public interface DependencyChangeRecord extends ChangeRecord<DependencyVersionChange> {
     /**
      * Describes where version item is updated.

versions-api/src/main/java/org/codehaus/mojo/versions/api/recording/PropertyChangeRecord.java

@@ -24,5 +24,7 @@
  *
  * @author Slawomir Jaranowski
  * @since 2.14.0
+ * @deprecated use classes from {@code versions-model}
  */
+@Deprecated
 public interface PropertyChangeRecord extends ChangeRecord<PropertyVersionChange> {}

versions-api/src/main/java/org/codehaus/mojo/versions/api/recording/VersionChangeRecorder.java

@@ -0,0 +1,59 @@
+package org.codehaus.mojo.versions.api.recording;
+
+/*
+ * Copyright MojoHaus and Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import org.codehaus.mojo.versions.model.VersionChange;
+
+/**
+ * Interface for implement a recorder of version changes.
+ *
+ * @since 2.20.0
+ */
+public interface VersionChangeRecorder {
+    /**
+     * Record that a version change
+     *
+     * @param versionChange a {@link VersionChange} object describing the change
+     * @since 2.20.0
+     */
+    void recordChange(VersionChange versionChange);
+
+    /**
+     * Write the current set of changes to the given output path.
+     * <p>
+     * Implementation is responsible for creating all missing directories.
+     * <p>
+     * Output should not be created for empty record sets.
+     *
+     * @param outputPath The output path, can be null, provided by <code>changeRecorderOutputFile</code>
+     *                   plugin parameters
+     * @throws IOException On write and/or I/O errors
+     * @since 2.20.0
+     */
+    void writeReport(Path outputPath) throws IOException;
+
+    /**
+     * Provides the default output file name
+     *
+     * @return default file name
+     */
+    String getDefaultFileName();
+}