Re: [PR] Include "[ci skip]" by default in scmReleaseCommitComment [maven-release]

["slawekjaranowski (via GitHub)" <gi...@apache.org>]

slawekjaranowski commented on code in PR #1423:
URL: https://github.com/apache/maven-release/pull/1423#discussion_r2541350740


##########
maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java:
##########
@@ -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]";

Review Comment:
   We should change a `defaultValue` attribute of `Parameter`
   
   default value for field will be always override ... probably used for testing



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org