Introduce ChangesetsVersionPolicy

magnusp · magnusp · commit d76528b22fe9 · 2025-03-11T14:57:04.000+01:00
diff --git a/.changeset/cyan-sloths-unite.md b/.changeset/cyan-sloths-unite.md
@@ -0,0 +1,5 @@
+---
+"changesets": minor
+---
+
+This change introduces a version policy (`ChangesetsVersionPolicy`) compatible with the Release Maven plugin, together with a flag `useReleasePluginIntegration` (default `false`) on the `prepare` goal. Enabling this flag will disable updating POM versions in `prepare` and only perform changeset processing. Updating versions in POMs can then be delegated to the Release plugin, together with all the other facilities that plugin provides.
diff --git a/README.md b/README.md
@@ -6,4 +6,39 @@ to enable easier management of changelogs and semantically versioned releases.
 Our goal is to keep compatibility with the files and formats of the original implementation as far as it makes sense, so that
 users recognize the ways of working and feel at home.
 
-This is it, at the moment. Stay tuned for more docs later on, thanks!
+This is it, at the moment. Stay tuned for more docs later on, thanks!
+
+# Release Maven Plugin Integration
+
+To delegate versioning to the Release Maven Plugin, you can use the `ChangesetsVersionPolicy` together with the `useReleasePluginIntegration` flag:
+
+```
+<build>
+  <plugins>
+    <plugin>
+      <groupId>se.fortnox.changesets</groupId>
+      <artifactId>changesets-maven-plugin</artifactId>
+      <version>${changesets.plugin.version}</version>
+      <configuration>
+        <useReleasePluginIntegration>true</useReleasePluginIntegration> <!-- Disables version updates in prepare goal -->
+      </configuration>
+    </plugin>
+    <plugin>
+      <artifactId>maven-release-plugin</artifactId>
+      <version>3.1.1</version>
+      <configuration>
+        <projectVersionPolicyId>changesets</projectVersionPolicyId>
+        <tagNameFormat>v@{project.version}</tagNameFormat>
+      </configuration>
+      <dependencies>
+        <dependency>
+          <groupId>se.fortnox.changesets</groupId>
+          <artifactId>changesets-maven-plugin</artifactId>
+          <version>${changesets.plugin.version}</version>
+        </dependency>
+      </dependencies>
+    </plugin>
+  </plugins>
+```
+
+Goals should then be invoked as `changesets:prepare release:prepare release:perform`. `changesets:release` should *not* be used.
diff --git a/changesets-java/src/main/java/se/fortnox/changesets/VersionCalculator.java b/changesets-java/src/main/java/se/fortnox/changesets/VersionCalculator.java
@@ -27,4 +27,10 @@ public static String getNewVersion(String version, List<Changeset> changes) {
 		}
 		return semanticVersion.getVersion();
 	}
+
+	public static String nextDevelopmentVersion(String actualVersion) {
+		return Optional.ofNullable(Semver.coerce(actualVersion))
+			.map(semver -> semver.withIncPatch().withPreRelease("SNAPSHOT").getVersion())
+			.orElseThrow(() -> new IllegalArgumentException("Cannot coerce \"%s\" into a semantic version.".formatted(actualVersion)));
+	}
 }
diff --git a/changesets-maven-plugin/pom.xml b/changesets-maven-plugin/pom.xml
@@ -43,7 +43,10 @@
 	    <dependency>
 		    <groupId>org.apache.maven.shared</groupId>
 		    <artifactId>maven-shared-utils</artifactId>
-		    <version>3.4.2</version>
+	    </dependency>
+	    <dependency>
+		    <groupId>org.apache.maven.release</groupId>
+		    <artifactId>maven-release-api</artifactId>
 	    </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>
@@ -72,6 +75,18 @@
 
     <build>
         <plugins>
+	        <plugin>
+		        <groupId>org.codehaus.plexus</groupId>
+		        <artifactId>plexus-component-metadata</artifactId>
+		        <executions>
+			        <execution>
+				        <id>process-classes</id>
+				        <goals>
+					        <goal>generate-metadata</goal>
+				        </goals>
+			        </execution>
+		        </executions>
+	        </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-plugin-plugin</artifactId>
@@ -94,6 +109,18 @@
                     </execution>
                 </executions>
             </plugin>
+	        <plugin>
+		        <groupId>org.eclipse.sisu</groupId>
+		        <artifactId>sisu-maven-plugin</artifactId>
+		        <executions>
+			        <execution>
+				        <id>generate-index</id>
+				        <goals>
+					        <goal>main-index</goal>
+				        </goals>
+			        </execution>
+		        </executions>
+	        </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/VERSION b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/VERSION
@@ -0,0 +1 @@
+2.4.5
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/nine-owls-knock.md b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/nine-owls-knock.md
@@ -0,0 +1,5 @@
+---
+"my-package": patch
+---
+
+A tiny change
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/seven-owls-suspect.md b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/.changeset/seven-owls-suspect.md
@@ -0,0 +1,5 @@
+---
+"my-package": minor
+---
+
+A medium change
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/EXPECTED_CHANGELOG.md b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/EXPECTED_CHANGELOG.md
@@ -0,0 +1,12 @@
+# my-package
+
+## 2.5.0
+
+### Minor Changes
+
+- A medium change
+
+### Patch Changes
+
+- A tiny change
+
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/invoker.properties b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/invoker.properties
@@ -0,0 +1,2 @@
+invoker.goals.1=${project.groupId}:${project.artifactId}:${project.version}:prepare
+invoker.goals.2=release:update-versions
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/pom.xml b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/pom.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>se.fortnox.maven.it</groupId>
+	<artifactId>my-package</artifactId>
+	<version>2.4.6-SNAPSHOT</version>
+
+	<description>A simple IT verifying the basic use case.</description>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+	</properties>
+
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-release-plugin</artifactId>
+				<version>3.1.1</version>
+				<configuration>
+					<projectVersionPolicyId>changesets</projectVersionPolicyId>
+					<pushChanges>false</pushChanges>
+				</configuration>
+				<dependencies>
+					<dependency>
+						<groupId>se.fortnox.changesets</groupId>
+						<artifactId>changesets-maven-plugin</artifactId>
+						<version>@project.version@</version>
+					</dependency>
+				</dependencies>
+			</plugin>
+		</plugins>
+	</build>
+</project>
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/test.properties b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/test.properties
@@ -0,0 +1 @@
+useReleasePluginIntegration=true
diff --git a/changesets-maven-plugin/src/it/prepare-release-plugin-integration/verify.groovy b/changesets-maven-plugin/src/it/prepare-release-plugin-integration/verify.groovy
@@ -0,0 +1,23 @@
+import groovy.xml.XmlSlurper
+
+import static org.assertj.core.api.Assertions.assertThat
+
+String expectedVersion = '2.5.0';
+String expectedSnapshot = '2.5.1-SNAPSHOT';
+
+// The VERSION file should contain the correct version number
+assertThat(new File(basedir, '.changeset/VERSION'))
+        .content()
+        .isEqualTo(expectedVersion)
+
+// The root pom version should be increased by one patch and be a snapshot
+def project = new XmlSlurper().parse(new File(basedir, 'pom.xml'))
+assertThat(project.version).isEqualTo(expectedSnapshot)
+
+// Verify that the CHANGELOG.md has been created correctly
+assertThat(new File(basedir, 'CHANGELOG.md'))
+        .hasSameTextualContentAs(new File(basedir, 'EXPECTED_CHANGELOG.md'))
+
+def buildLog = new File( basedir, "build.log").text
+assert buildLog =~ /Changesets processed, but not updating POMs due to useReleasePluginIntegration being set to true/
+true
diff --git a/changesets-maven-plugin/src/main/java/se/fortnox/changesets/VersionFile.java b/changesets-maven-plugin/src/main/java/se/fortnox/changesets/VersionFile.java
@@ -0,0 +1,45 @@
+package se.fortnox.changesets;
+
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.logging.Logger;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+import java.util.Optional;
+
+import static se.fortnox.changesets.ChangesetWriter.CHANGESET_DIR;
+
+@Singleton
+public class VersionFile {
+	private final Path versionFile;
+
+	@Inject
+	public VersionFile(MavenProject project, Logger log) {
+		this.versionFile = project.getBasedir().toPath().resolve(CHANGESET_DIR).resolve("VERSION").toAbsolutePath();
+		log.info("Using version file " + versionFile);
+	}
+
+	public Optional<String> currentVersion() {
+		if(!Files.exists(versionFile)) {
+			return Optional.empty();
+		}
+		try {
+			return Optional.of(Files.readString(versionFile));
+		} catch (IOException e) {
+			return Optional.empty();
+		}
+	}
+
+	public void assignVersion(String newVersion) {
+		try {
+			Files.writeString(versionFile, newVersion, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
+		} catch (IOException e) {
+			throw new RuntimeException(e);
+		}
+	}
+}
diff --git a/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/PrepareMojo.java b/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/PrepareMojo.java
@@ -4,32 +4,44 @@
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.logging.Logger;
 import org.semver4j.Semver;
 import se.fortnox.changesets.ChangelogAggregator;
 import se.fortnox.changesets.Changeset;
 import se.fortnox.changesets.ChangesetLocator;
 import se.fortnox.changesets.VersionCalculator;
+import se.fortnox.changesets.VersionFile;
 
+import javax.inject.Inject;
 import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
-import java.nio.file.StandardOpenOption;
 import java.util.List;
 import java.util.Optional;
 
-import static se.fortnox.changesets.ChangesetWriter.CHANGESET_DIR;
-
 /**
  * Applies all changesets into the changelog and calculates the new version number.
  * <p>
  * This would normally be the last step in preparing a release PR.
  */
 @Mojo(name = "prepare", defaultPhase = LifecyclePhase.INITIALIZE)
 public class PrepareMojo extends AbstractMojo {
-	@Parameter(defaultValue = "${project}", readonly = true, required = true)
-	private org.apache.maven.project.MavenProject project;
+	private final org.apache.maven.project.MavenProject project;
+	private final VersionFile versionFile;
+	private final Logger logger;
+
+	@Inject
+	public PrepareMojo(MavenProject project, VersionFile versionFile, Logger logger) {
+		this.project = project;
+		this.versionFile = versionFile;
+		this.logger = logger;
+	}
+
+	/*
+	 * Set to true in order to just process changeset files, avoiding any changes to the POM(s).
+	 */
+	@Parameter(property = "useReleasePluginIntegration", defaultValue = "false")
+	protected boolean useReleasePluginIntegration = false;
 
 	public void execute() {
 		Path baseDir = project.getBasedir().toPath();
@@ -40,23 +52,25 @@ public void execute() {
 		List<Changeset> changesets = changesetLocator.getChangesets(packageName);
 
 		if (changesets.isEmpty()) {
-			getLog().info("No changesets for package: " + packageName + " found in " + baseDir);
+			logger.info("No changesets for package: " + packageName + " found in " + baseDir);
 			return;
 		}
 
 		// Calculate new version
-		String currentVersion = getCurrentVersion();
+		String currentVersion = versionFile.currentVersion().orElse("0.0.0");;
 		String newVersion = VersionCalculator.getNewVersion(currentVersion, changesets);
-		getLog().info("Old version was " + currentVersion + ", will be updated to " + newVersion);
+		logger.info("Old version was " + currentVersion + ", will be updated to " + newVersion);
 
 		// Move changesets into CHANGELOG.md
 		ChangelogAggregator changelogAggregator = new ChangelogAggregator(baseDir);
 		changelogAggregator.mergeChangesetsToChangelog(packageName, newVersion);
 
-		try {
-			Files.writeString(project.getBasedir().toPath().resolve(CHANGESET_DIR).resolve("VERSION"), newVersion, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
-		} catch (IOException e) {
-			throw new RuntimeException(e);
+		// Advance to version deduced from changesets
+		versionFile.assignVersion(newVersion);
+
+		if(useReleasePluginIntegration) {
+			logger.info("Changesets processed, but not updating POMs due to useReleasePluginIntegration being set to true.");
+			return;
 		}
 
 		// Set newVersion property to be used by versions:set
@@ -66,30 +80,16 @@ public void execute() {
 				.orElseThrow(() -> new IllegalArgumentException("Cannot coerce \"%s\" into a semantic version.".formatted(currentVersion)));
 
 
-			getLog().info("Updating " + project.getFile() + " to " + pomVersion);
+			logger.info("Updating " + project.getFile() + " to " + pomVersion);
 			PomUpdater.setProjectVersion(project.getFile(), pomVersion);
 
 			// Update submodules to reference the parent project with the new version
 			List<String> modules = project.getModules();
 			modules.forEach(module -> {
 				File modulePom = baseDir.resolve(module).resolve("pom.xml").toFile();
-				getLog().info("Updating submodule" + modulePom + " to " + pomVersion);
+				logger.info("Updating submodule" + modulePom + " to " + pomVersion);
 				PomUpdater.setProjectParentVersion(modulePom, pomVersion);
 			});
 		}
 	}
-
-	private String getCurrentVersion() {
-		try {
-			Path versionFile = project.getBasedir().toPath().resolve(CHANGESET_DIR).resolve("VERSION");
-			getLog().info("Reading version from " + versionFile);
-			return Files.readString(versionFile);
-
-		} catch (NoSuchFileException exception) {
-			return "0.0.0";
-
-		} catch (IOException e) {
-			throw new RuntimeException(e);
-		}
-	}
 }
diff --git a/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/ReleaseMojo.java b/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/ReleaseMojo.java
diff --git a/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/policy/ChangesetsVersionPolicy.java b/changesets-maven-plugin/src/main/java/se/fortnox/changesets/maven/policy/ChangesetsVersionPolicy.java
diff --git a/pom.xml b/pom.xml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"changesets": minor
 +---
++
 +This change introduces a version policy (`ChangesetsVersionPolicy`) compatible with the Release Maven plugin, together with a flag `useReleasePluginIntegration` (default `false`) on the `prepare` goal. Enabling this flag will disable updating POM versions in `prepare` and only perform changeset processing. Updating versions in POMs can then be delegated to the Release plugin, together with all the other facilities that plugin provides.
Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,10 @@ public static String getNewVersion(String version, List<Changeset> changes) {`
`27`	`27`	`}`
`28`	`28`	`return semanticVersion.getVersion();`
`29`	`29`	`}`
	`30`	`+`
	`31`	`+ public static String nextDevelopmentVersion(String actualVersion) {`
	`32`	`+ return Optional.ofNullable(Semver.coerce(actualVersion))`
	`33`	`+ .map(semver -> semver.withIncPatch().withPreRelease("SNAPSHOT").getVersion())`
	`34`	`+ .orElseThrow(() -> new IllegalArgumentException("Cannot coerce \"%s\" into a semantic version.".formatted(actualVersion)));`
	`35`	`+ }`
`30`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+invoker.goals.1=${project.groupId}:${project.artifactId}:${project.version}:prepare`
	`2`	`+invoker.goals.2=release:update-versions`