(maven-release) 01/01: Include "[ci-skip]" by default in scmReleaseCommitComment

[kw...@apache.org]

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

kwin pushed a commit to branch feature/ci-skip
in repository https://gitbox.apache.org/repos/asf/maven-release.git

commit 4c87526ddf902608255b01b2754f6787888344d7
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Nov 19 10:56:53 2025 +0100

    Include "[ci-skip]" by default in scmReleaseCommitComment
    
    This leads to skipping this commit from auto-building with most CI/CD
    systems.
    Compare with
    https://docs.github.com/en/actions/how-tos/manage-workflow-runs/skip-workflow-runs,
    https://docs.gitlab.com/ci/pipelines/#skip-a-pipeline and
    https://plugins.jenkins.io/scmskip/
---
 .../apache/maven/plugins/release/PrepareReleaseMojo.java    | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
index 796baf62..d9766714 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
@@ -269,7 +269,7 @@ public class PrepareReleaseMojo extends AbstractScmReadWriteReleaseMojo {
     private String projectTagNamingPolicyId;
 
     /**
-     * The SCM commit comment when setting pom.xml to release.
+     * The SCM commit comment for the commit setting pom.xml to release version.
      * Defaults to "@{prefix} prepare release @{releaseLabel}".
      * <p>
      * Property interpolation is performed on the value, but in order to ensure that the interpolation occurs
@@ -281,14 +281,19 @@ public class PrepareReleaseMojo extends AbstractScmReadWriteReleaseMojo {
      *     <li><code>artifactId</code> - The artifactId of the root project.
      *     <li><code>releaseLabel</code> - The release version of the root project.
      * </ul>
-     *
+     * It is recommended to automatically skip this commit from the default CI/CD build by including the string {@code ci skip} 
+     * in the commit message which is understood
+     * by most CI systems, like <a href="https://docs.github.com/en/actions/how-tos/manage-workflow-runs/skip-workflow-runs">GitHub Actions</a>,
+     * <a href="https://docs.gitlab.com/ci/pipelines/#skip-a-pipeline">GitLab Pipelines</a>, and probably some more.
+     * Otherwise the non-SNAPSHOT version is built again (outside the actual release) and potentially also deployed somewhere
+     * (which often leads to failed builds).
      * @since 3.0.0-M1
      */
     @Parameter(defaultValue = "@{prefix} prepare release @{releaseLabel}", property = "scmReleaseCommitComment")
-    private String scmReleaseCommitComment = "@{prefix} prepare release @{releaseLabel}";
+    private String scmReleaseCommitComment = "@{prefix} prepare release @{releaseLabel} [ci skip]";
 
     /**
-     * The SCM commit comment when setting pom.xml back to development.
+     * The SCM commit comment for the commit setting pom.xml back to development version.
      * Defaults to "@{prefix} prepare for next development iteration".
      * <p>
      * Property interpolation is performed on the value, but in order to ensure that the interpolation occurs