feat: update version based on conventional commits

Author: tomasbjerre

README.md

@@ -7,9 +7,9 @@ This is a Maven plugin for [Git Changelog Lib](https://github.com/tomasbjerre/gi
 
 ## Usage
 
-There is a running example [here](https://github.com/tomasbjerre/git-changelog-maven-plugin/tree/master/git-changelog-maven-plugin-example).
+There is a running example [here](/git-changelog-maven-plugin-example).
 
-Have a look at the [pom.xml](https://github.com/tomasbjerre/git-changelog-maven-plugin/blob/master/git-changelog-maven-plugin-example/pom.xml) where you will find some more examples.
+Have a look at the [pom.xml](/git-changelog-maven-plugin-example/pom.xml) where you will find some more examples.
 
 Here is and example that will generate a CHANGELOG.md when running `mvn generate-resources`.
 
@@ -176,3 +176,24 @@ Handlebars.registerHelper('firstLetters', function(from, options) {
 ```
 
 More documentation can be found in the [Git Changelog Lib](https://github.com/tomasbjerre/git-changelog-lib).
+
+### Configuration
+
+Have a look at the [pom.xml](/git-changelog-maven-plugin-example/pom.xml) where you will find some more examples.
+
+#### Update version based on conventional commits
+
+The version in `pom.xml` can be automatically updated based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+```xml
+<configuration>
+	<!-- Skip changelog generation //-->
+	<skip>true</skip>
+
+	<!-- Update the <version> tag //-->
+	<updatePomWithNextSemanticVersion>true</updatePomWithNextSemanticVersion>
+
+	<!-- suffix version with -SNAPSHOT //-->
+	<updatePomWithNextSemanticVersionSuffixSnapshot>true</updatePomWithNextSemanticVersionSuffixSnapshot>
+</configuration>
+```

git-changelog-maven-plugin-example/CHANGELOG_custom.md

@@ -4,7 +4,7 @@ Changelog of Git Changelog Maven plugin.
 
 ## Unreleased
 ### No issue / 
-   feat: enable updating version in pom based on conventional commits
+   chore: build script
 
    chore: updating changelog
 

git-changelog-maven-plugin-example/CHANGELOG_ignoreCommitsOlderThan.md

@@ -4,7 +4,7 @@ Changelog of Git Changelog Maven plugin.
 
 ## Unreleased
 ### No issue
-   feat: enable updating version in pom based on conventional commits *2022-09-25 09:53:19*
+   chore: build script *2022-09-25 09:55:05*
 
    chore: updating changelog *2022-09-24 13:38:39*
 

git-changelog-maven-plugin-example/CHANGELOG_inline.md

@@ -5,9 +5,9 @@ Changelog of Git Changelog Maven plugin.
 ## Unreleased
 ### No issue
 
-[0f849cb7d7597c6](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/0f849cb7d7597c6) Tomas Bjerre *2022-09-25 09:53:19*
+[52bb4c3f9e02589](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/52bb4c3f9e02589) Tomas Bjerre *2022-09-25 09:55:05*
 
-feat: enable updating version in pom based on conventional commits
+chore: build script
 
 [9a6f68a7468860f](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/9a6f68a7468860f) Tomas Bjerre *2022-09-24 13:38:39*
 

git-changelog-maven-plugin-example/CHANGELOG_mixed.md

@@ -4,7 +4,7 @@ Changelog of Git Changelog Maven plugin.
 
 ## These commits are not included in any tag
 ### These commits have not issue in their commit comment
-   feat: enable updating version in pom based on conventional commits *09:53:19*
+   chore: build script *09:55:05*
 
    chore: updating changelog *13:38:39*
 

git-changelog-maven-plugin-example/CHANGELOG_settings.md

@@ -4,10 +4,6 @@ Changelog of git-changelog-maven-plugin.
 
 ## Next release ()
 
-### Features
-
--  enable updating version in pom based on conventional commits ([0f849](https://github.com/tomasbjerre/git-changelog-maven-plugin/commit/0f849cb7d7597c6) Tomas Bjerre)  
-
 ## 1.92.2 (2022-09-24)
 
 ### Bug Fixes

git-changelog-maven-plugin-example/pom.xml

@@ -1,12 +1,9 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>se.bjurr.gitchangelog</groupId>
 	<artifactId>git-changelog-maven-plugin-example</artifactId>
 	<name>git-changelog-maven-plugin-example</name>
-	<version>1.0-SNAPSHOT</version>
+	<version>1.92.3-SNAPSHOT</version>
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<maven.compiler.target>1.8</maven.compiler.target>
@@ -453,8 +450,19 @@ Handlebars.registerHelper('firstLetters', function(from, options) {
 							</templateContent>
 						</configuration>
 					</execution>
+					<execution>
+						<id>UpdateVersionInPom</id>
+						<phase>generate-sources</phase>
+						<goals>
+							<goal>git-changelog</goal>
+						</goals>
+						<configuration>
+							<skip>true</skip>
+							<updatePomWithNextSemanticVersion>true</updatePomWithNextSemanticVersion>
+						</configuration>
+					</execution>
 				</executions>
 			</plugin>
 		</plugins>
 	</build>
-</project>
+</project>

pom.xml

@@ -55,6 +55,11 @@
 			<version>3.6.0</version>
 			<scope>provided</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.apache.maven</groupId>
+			<artifactId>maven-core</artifactId>
+			<version>3.6.0</version>
+		</dependency>
 		<dependency>
 			<groupId>org.apache.maven.plugin-tools</groupId>
 			<artifactId>maven-plugin-annotations</artifactId>

src/main/java/se/bjurr/gitchangelog/plugin/GitChangelogMojo.java

@@ -11,16 +11,22 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import org.apache.maven.model.Model;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
 import se.bjurr.gitchangelog.api.GitChangelogApi;
+import se.bjurr.gitchangelog.internal.semantic.SemanticVersion;
 
 @Mojo(name = "git-changelog", defaultPhase = PROCESS_SOURCES, threadSafe = true)
 public class GitChangelogMojo extends AbstractMojo {
   private static final String DEFAULT_FILE = "CHANGELOG.md";
 
+  @Component private MavenProject project;
+
   @Parameter(property = "toRef", required = false)
   private String toRef;
 
@@ -42,7 +48,8 @@ public class GitChangelogMojo extends AbstractMojo {
   @Parameter(property = "extendedHeaders", required = false)
   private Map extendedHeaders;
 
-  // map variables cannot be passed through maven cli use this property as a workaround
+  // map variables cannot be passed through maven cli use this property as a
+  // workaround
   @Parameter(property = "extendedVariablesCli", required = false)
   private String[] extendedVariablesCli;
 
@@ -175,8 +182,43 @@ public class GitChangelogMojo extends AbstractMojo {
   @Parameter(property = "prependToFile", required = false)
   public Boolean prependToFile;
 
+  @Parameter(
+      property = "updatePomWithNextSemanticVersion",
+      required = false,
+      defaultValue = "false")
+  private boolean updatePomWithNextSemanticVersion;
+
+  @Parameter(
+      property = "updatePomWithNextSemanticVersionSuffixSnapshot",
+      required = false,
+      defaultValue = "true")
+  private boolean updatePomWithNextSemanticVersionSuffixSnapshot;
+
   @Override
   public void execute() throws MojoExecutionException {
+    if (this.updatePomWithNextSemanticVersion) {
+      try {
+        final SemanticVersion nextSemanticVersion =
+            gitChangelogApiBuilder().getNextSemanticVersion();
+        final String nextVersion =
+            this.updatePomWithNextSemanticVersionSuffixSnapshot
+                ? nextSemanticVersion.getVersion() + "-SNAPSHOT"
+                : nextSemanticVersion.getVersion();
+
+        final Model model = this.project.getModel();
+        final String versionOrig = model.getVersion();
+        final File pomFile = this.project.getFile();
+        this.getLog()
+            .info("Setting version to " + nextVersion + " was (" + versionOrig + ") in " + pomFile);
+        // Change version during build
+        model.setVersion(nextVersion);
+
+        // Change version in file
+        new XmlModifier(pomFile).setVersion(nextVersion);
+      } catch (final Exception e) {
+        throw new MojoExecutionException(e.getMessage(), e);
+      }
+    }
     if (this.skip != null && this.skip == true) {
       this.getLog().info("Skipping changelog generation");
       return;

src/main/java/se/bjurr/gitchangelog/plugin/XmlModifier.java

@@ -0,0 +1,66 @@
+package se.bjurr.gitchangelog.plugin;
+
+import java.io.File;
+import java.io.IOException;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
+
+public class XmlModifier {
+
+  private final File file;
+
+  public XmlModifier(final File file) {
+    this.file = file;
+  }
+
+  public void setVersion(final String value) throws Exception {
+    final Document document = this.readDocument();
+
+    final Node projectNode = this.getNode(document.getChildNodes(), "project");
+    final Node versionNode = this.getNode(projectNode.getChildNodes(), "version");
+    versionNode.setTextContent(value);
+
+    this.saveDocument(document);
+  }
+
+  private Document readDocument() throws ParserConfigurationException, SAXException, IOException {
+    final DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
+    final DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
+    final Document document = dBuilder.parse(this.file);
+    return document;
+  }
+
+  private void saveDocument(final Node document) throws Exception {
+    final TransformerFactory transformerFactory = TransformerFactory.newInstance();
+    final Transformer transformer = transformerFactory.newTransformer();
+    final DOMSource source = new DOMSource(document);
+    final StreamResult result = new StreamResult(this.file);
+    transformer.transform(source, result);
+  }
+
+  private Node getNode(final NodeList nodes, final String tagName) {
+    Node found = null;
+    for (int tagIndex = 0; tagIndex < nodes.getLength(); tagIndex++) {
+      final Node tag = nodes.item(tagIndex);
+      if (tag.getNodeName().equals(tagName)) {
+        if (found != null) {
+          throw new RuntimeException("Found multiple " + tagName + " in " + nodes);
+        }
+        found = tag;
+      }
+    }
+    if (found == null) {
+      throw new RuntimeException("Cannot find " + tagName + " in " + nodes);
+    }
+    return found;
+  }
+}