Added Git integration, script execution and more configurability

.github/workflows/push-release.yaml

@@ -31,16 +31,12 @@ jobs:
           set -e
           ./mvnw --no-transfer-progress --batch-mode install -Dgpg.skip
           CURRENT_VERSION=$(./mvnw --no-transfer-progress --batch-mode help:evaluate -Dexpression=project.version -q -DforceStdout)
-          ./mvnw --no-transfer-progress --batch-mode io.github.bsels:semantic-version-maven-plugin:$CURRENT_VERSION:update
+          ./mvnw --no-transfer-progress --batch-mode io.github.bsels:semantic-version-maven-plugin:$CURRENT_VERSION:update \
+          -Dversioning.update.scripts=./update-readme.sh -Dversioning.git=COMMIT
           VERSION=$(./mvnw --no-transfer-progress --batch-mode help:evaluate -Dexpression=project.version -q -DforceStdout)
           echo "version=$VERSION" >> $GITHUB_OUTPUT
-      - name: Update version in README
+      - name: Create tag and push
         run: |
-          sed -i 's/<version>[0-9]\+[.][0-9]\+[.][0-9]\+<\/version>/<version>${{ steps.bumpVersion.outputs.version }}<\/version>/g' README.md
-      - name: Commit changes
-        run: |
-          git add .versioning CHANGELOG.md pom.xml
-          git commit -am "Released ${{ steps.bumpVersion.outputs.version }} [skip ci]"
           git tag "v${{ steps.bumpVersion.outputs.version }}"
           git push
           git push origin tag "v${{ steps.bumpVersion.outputs.version }}"

.github/workflows/release-build.yaml

@@ -9,7 +9,7 @@ on:
         required: true
         type: string
 permissions:
-  contents: read
+  contents: write
 jobs:
   build:
     name: Build
@@ -43,5 +43,13 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SERVER_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
           SERVER_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_KEY_PASSWORD }}
         run: |
-          ./mvnw --batch-mode --no-transfer-progress clean deploy -Dgpg.passphrase=${{ secrets.GPG_KEY_PASSWORD }}
+          ./mvnw --batch-mode --no-transfer-progress clean deploy
+      - name: Zip coverage report
+        working-directory: ./target/site/jacoco
+        run: |
+          zip -r9 ../../../coverage-report.zip *
+      - name: Attach coverage report to release
+        run: |
+          gh release upload ${{ github.event.release.tag_name }} coverage-report.zip

.versioning/versioning-20260122190538.md

@@ -0,0 +1,9 @@
+---
+io.github.bsels:semantic-version-maven-plugin: "PATCH"
+---
+
+Bumped dependencies:
+
+- Jackson from 2.20.1 to 2.21.0
+- JUnit from 6.0.1 to 6.0.2
+- Central publishing maven plugin from 0.9.0 to 0.10.0

.versioning/versioning-20260122190648.md

@@ -0,0 +1,5 @@
+---
+io.github.bsels:semantic-version-maven-plugin: "MINOR"
+---
+
+Added support for git for automated stashing or committing from files.

.versioning/versioning-20260124102122.md

@@ -0,0 +1,5 @@
+---
+io.github.bsels:semantic-version-maven-plugin: "MINOR"
+---
+
+Support additional script execution during version bump for more customization

.versioning/versioning-20260124134430.md

@@ -0,0 +1,5 @@
+---
+io.github.bsels:semantic-version-maven-plugin: "MINOR"
+---
+
+Make the version header configurable with placeholders for the version and the date and allow custom date formats.

.versioning/versioning-20260124151654.md

@@ -0,0 +1,5 @@
+---
+io.github.bsels:semantic-version-maven-plugin: "MINOR"
+---
+
+Added mode to only use artifact ID as identifier in the file based versioning.

pom.xml

@@ -40,6 +40,7 @@
     <properties>
         <java.version>17</java.version>
         <!--region Plugin versions -->
+        <jacoco.version>0.8.14</jacoco.version>
         <maven.plugin.api.version>3.9.12</maven.plugin.api.version>
         <maven.enforcer.plugin.version>3.6.2</maven.enforcer.plugin.version>
         <maven.dependency.plugin.version>3.9.0</maven.dependency.plugin.version>
@@ -49,13 +50,13 @@
         <maven.gpg.plugin.version>3.2.8</maven.gpg.plugin.version>
         <maven.javadoc.plugin.version>3.12.0</maven.javadoc.plugin.version>
         <maven.source.plugin.version>3.4.0</maven.source.plugin.version>
-        <central.publishing.maven.plugin.version>0.9.0</central.publishing.maven.plugin.version>
+        <central.publishing.maven.plugin.version>0.10.0</central.publishing.maven.plugin.version>
         <!--endregion-->
         <!--region Dependency versions -->
         <assertj.version>3.27.6</assertj.version>
         <commonmark.version>0.27.0</commonmark.version>
-        <jackson.version>2.20.1</jackson.version>
-        <junit.version>6.0.1</junit.version>
+        <jackson.version>2.21.0</jackson.version>
+        <junit.version>6.0.2</junit.version>
         <maven.plugin.version>3.15.2</maven.plugin.version>
         <mockito.version>5.21.0</mockito.version>
         <!--endregion-->
@@ -69,6 +70,30 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>${jacoco.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>default-report</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                        <configuration>
+                            <formats>
+                                <format>HTML</format>
+                            </formats>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-enforcer-plugin</artifactId>
@@ -119,7 +144,7 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>${maven.surefire.plugin.version}</version>
                 <configuration>
-                    <argLine>-javaagent:${org.mockito:mockito-core:jar}</argLine>
+                    <argLine>@{argLine} -javaagent:${org.mockito:mockito-core:jar}</argLine>
                 </configuration>
             </plugin>
             <plugin>

src/main/java/io/github/bsels/semantic/version/BaseMojo.java

@@ -4,8 +4,11 @@
 import io.github.bsels.semantic.version.models.MavenArtifact;
 import io.github.bsels.semantic.version.models.SemanticVersionBump;
 import io.github.bsels.semantic.version.models.VersionMarkdown;
+import io.github.bsels.semantic.version.parameters.ArtifactIdentifier;
+import io.github.bsels.semantic.version.parameters.Git;
 import io.github.bsels.semantic.version.parameters.Modus;
 import io.github.bsels.semantic.version.utils.MarkdownUtils;
+import io.github.bsels.semantic.version.utils.ProcessUtils;
 import io.github.bsels.semantic.version.utils.Utils;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
@@ -123,13 +126,30 @@ public abstract sealed class BaseMojo extends AbstractMojo permits CreateVersion
     @Parameter(property = "versioning.directory", required = true, defaultValue = ".versioning")
     protected Path versionDirectory = Path.of(".versioning");
 
+    /// Represents the Git version control system configuration for the Maven plugin.
+    /// Used to manage versioning-related operations specific to Git.
+    ///
+    /// By default, the value is set to [Git#NO_GIT],
+    /// indicating that no Git-specific actions will be performed unless explicitly configured.
+    ///
+    /// This field can be overridden by specifying the Maven property `versioning.git`.
+    @Parameter(property = "versioning.git", required = true, defaultValue = "NO_GIT")
+    protected Git git = Git.NO_GIT;
+
     /// Indicates whether the original POM file and CHANGELOG file should be backed up before modifying its content.
     ///
     /// This parameter is configurable via the Maven property `versioning.backup`.
     /// When set to `true`, a backup of the POM/CHANGELOG file will be created before any updates are applied.
     /// The default value for this parameter is `false`, meaning no backup will be created unless explicitly specified.
-    @Parameter(property = "versioning.backup", defaultValue = "false")
-    boolean backupFiles = false;
+    @Parameter(property = "versioning.backup", required = true, defaultValue = "false")
+    protected boolean backupFiles = false;
+
+    /// Specifies the mode of artifact identification within a repository or dependency context.
+    /// This parameter is configurable via the Maven property `versioning.identifier`.
+    /// The default value is [ArtifactIdentifier#GROUP_ID_AND_ARTIFACT_ID],
+    /// which includes both the group ID and artifact ID.
+    @Parameter(property = "versioning.identifier", required = true, defaultValue = "GROUP_ID_AND_ARTIFACT_ID")
+    protected ArtifactIdentifier identifier = ArtifactIdentifier.GROUP_ID_AND_ARTIFACT_ID;
 
     /// Default constructor for the BaseMojo class.
     /// Initializes the instance by invoking the superclass constructor.
@@ -210,7 +230,12 @@ protected final List<VersionMarkdown> getVersionMarkdowns() throws MojoExecution
                     .toList();
             List<VersionMarkdown> parsedMarkdowns = new ArrayList<>();
             for (Path markdownFile : markdownFiles) {
-                parsedMarkdowns.add(MarkdownUtils.readVersionMarkdown(log, markdownFile));
+                parsedMarkdowns.add(MarkdownUtils.readVersionMarkdown(
+                        log,
+                        markdownFile,
+                        identifier,
+                        session.getCurrentProject().getGroupId()
+                ));
             }
             versionMarkdowns = List.copyOf(parsedMarkdowns);
         } catch (IOException e) {
@@ -333,6 +358,7 @@ protected void writeMarkdownFile(Node markdownNode, Path markdownFile)
         } else {
             MarkdownUtils.writeMarkdownFile(markdownFile, markdownNode, backupFiles);
         }
+        stashFiles(List.of(markdownFile));
     }
 
     /// Simulates writing to a file by using a [StringWriter].
@@ -354,6 +380,29 @@ protected void dryRunWriteFile(MojoThrowingConsumer<StringWriter> consumer, Path
         }
     }
 
+    /// Stashes the provided list of file paths using Git if stashing is enabled and not in dry-run mode.
+    ///
+    /// @param files the list of file paths to be stashed
+    /// @throws MojoExecutionException if an error occurs during the stashing process
+    protected void stashFiles(List<Path> files) throws MojoExecutionException {
+        if (!dryRun && git.isStash()) {
+            ProcessUtils.gitStashFiles(files);
+        }
+    }
+
+    /// Commits changes to a Git repository if specific conditions are met.
+    /// The commit operation will only be performed when:
+    /// - Git commit mode is enabled ([Git#isCommit] returns true)
+    /// - Dry-run mode is disabled (dryRun is false)
+    ///
+    /// @param message The commit message to use for the commit operation.
+    /// @throws MojoExecutionException If the commit operation fails.
+    protected void commit(String message) throws MojoExecutionException {
+        if (!dryRun && git.isCommit()) {
+            ProcessUtils.gitCommit(message);
+        }
+    }
+
     /// Functional interface that represents an operation that accepts a single input
     /// and can throw [MojoExecutionException] and [MojoFailureException].
     ///

src/main/java/io/github/bsels/semantic/version/CreateVersionMarkdownMojo.java

@@ -1,6 +1,7 @@
 package io.github.bsels.semantic.version;
 
 import io.github.bsels.semantic.version.models.MavenArtifact;
+import io.github.bsels.semantic.version.models.PlaceHolderWithType;
 import io.github.bsels.semantic.version.models.SemanticVersionBump;
 import io.github.bsels.semantic.version.utils.MarkdownUtils;
 import io.github.bsels.semantic.version.utils.ProcessUtils;
@@ -13,6 +14,7 @@
 import org.apache.maven.plugins.annotations.Execute;
 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.plugins.annotations.ResolutionScope;
 import org.commonmark.node.Node;
 
@@ -56,6 +58,24 @@ public final class CreateVersionMarkdownMojo extends BaseMojo {
             SemanticVersionBump.PATCH, SemanticVersionBump.MINOR, SemanticVersionBump.MAJOR
     );
 
+    /// Represents the commit message for creating a version Markdown file.
+    /// This variable is essential for customizing the commit message applied when creating a version Markdown file.
+    ///
+    /// The placeholder `"{numberOfProjects}"` is used to dynamically insert the number of projects for which
+    /// the version file was created into the message.
+    ///
+    /// Attributes:
+    /// - property: Specifies the configuration property key to override this value.
+    /// - required: Signifies that this parameter is mandatory.
+    /// - defaultValue: If not explicitly specified,
+    ///   defaults to `"Created version Markdown file for {numberOfProjects} project(s)"`.
+    @Parameter(
+            property = "versioning.commit.message.create",
+            required = true,
+            defaultValue = "Created version Markdown file for {numberOfProjects} project(s)"
+    )
+    String commitMessage = "Created version Markdown file for {numberOfProjects} project(s)";
+
     /// Default constructor for the CreateVersionMarkdownMojo class.
     /// Invokes the superclass constructor to initialize the instance.
     /// This constructor is typically used by the Maven framework during the build lifecycle.
@@ -79,6 +99,11 @@ public CreateVersionMarkdownMojo() {
     /// @throws MojoFailureException   if the operation to process or create the version Markdown file fails.
     @Override
     protected void internalExecute() throws MojoExecutionException, MojoFailureException {
+        commitMessage = Utils.prepareFormatString(
+                commitMessage,
+                List.of(new PlaceHolderWithType("numberOfProjects", "d"))
+        );
+
         Log log = getLog();
         List<MavenArtifact> projects = getProjectsInScope()
                 .map(mavenProject -> new MavenArtifact(mavenProject.getGroupId(), mavenProject.getArtifactId()))
@@ -93,14 +118,15 @@ protected void internalExecute() throws MojoExecutionException, MojoFailureExcep
             return;
         }
 
-        YamlFrontMatterBlock versionBumpHeader = MarkdownUtils.createVersionBumpsHeader(log, selectedProjects);
+        YamlFrontMatterBlock versionBumpHeader = MarkdownUtils.createVersionBumpsHeader(log, selectedProjects, identifier);
         Node inputMarkdown = createChangelogEntry();
         inputMarkdown.prependChild(versionBumpHeader);
 
         Path versioningFolder = getVersioningFolder();
         Utils.createDirectoryIfNotExists(versioningFolder);
         Path versioningFile = Utils.resolveVersioningFile(versioningFolder);
         writeMarkdownFile(inputMarkdown, versioningFile);
+        commit(commitMessage.formatted(selectedProjects.size()));
     }
 
     /// Creates a changelog entry by either taking user input directly or by leveraging an external editor.