Merge pull request #565 from SimonGolms/feature/skipping-commits

feat: improve skipping commits

Author: Michael Sauter

docs/modules/jenkins-shared-library/partials/odsComponentPipeline.adoc

@@ -414,4 +414,18 @@ def sayHello(def context) {
 
 === Skipping pipeline runs
 
-If the message of the built commit contains `[ci skip]`, the pipeline is skipped. The Jenkins build status will be set to `NOT_BUILT`, the Bitbucket build status to `SUCCESSFUL` (as there is no "skipped" state). The pipeline will start to execute initially, but abort before launching any agent nodes or starting any of the stages defined in the `Jenkinsfile`.
+If the subject of the built commit message contains `[ci skip]`, `[skip ci]` or `\\***NO_CI***`, the pipeline is skipped.
+[source,sh]
+skip
+----
+# skip pipeline (one-line commit)
+$ git commit -m "docs: update README [ci skip]"
+
+# run pipeline (multi-line commit) as it is not part of the subject
+$ git commit -m "docs: update README
+
+- add section installation
+- [ci skip]"
+----
+
+The Jenkins build status will be set to `NOT_BUILT`, the Bitbucket build status to `SUCCESSFUL` (as there is no "skipped" state). The pipeline will start to execute initially, but abort before launching any agent nodes or starting any of the stages defined in the `Jenkinsfile`.

src/org/ods/component/Pipeline.groovy

@@ -149,7 +149,8 @@ class Pipeline implements Serializable {
 
                     skipCi = isCiSkip()
                     if (skipCi) {
-                        logger.info 'Skipping build due to [ci skip] in the commit message ...'
+                        logger.info 'Skipping build due to [ci skip], [skip ci] or ***NO_CI***' +
+                            'in the commit message ...'
                         updateBuildStatus('NOT_BUILT')
                         setBitbucketBuildStatus('SUCCESSFUL')
                         return

src/org/ods/services/GitService.groovy

@@ -108,6 +108,14 @@ class GitService {
         ).trim()
     }
 
+    String getCommitSubject() {
+        script.sh(
+            returnStdout: true,
+            script: 'git show --pretty=%s -s',
+            label: 'Get Git commit subject'
+        ).trim()
+    }
+
     String getCommitMessage() {
         script.sh(
             returnStdout: true,
@@ -124,12 +132,25 @@ class GitService {
         ).trim()
     }
 
-    /** Looks in commit message for string '[ci skip]', '[ciskip]', '[ci-skip]' and '[ci_skip]'. */
-    boolean isCiSkipInCommitMessage() {
-        return script.sh(
-            returnStdout: true, script: 'git show --pretty=%s%b -s',
-            label: 'check skip CI?'
-        ).toLowerCase().replaceAll('[\\s\\-\\_]', '').contains('[ciskip]')
+    /** Looks in commit message for the following strings
+     *  '[ci skip]', '[ciskip]', '[ci-skip]', '[ci_skip]',
+     *  '[skip ci]', '[skipci]', '[skip-ci]', '[skip_ci]',
+     *  '***NO_CI***', '***NO CI***', '***NOCI***', '***NO-CI***'
+     */
+    boolean isCiSkipInCommitMessage(String gitCommit = '') {
+        def gitCommitSubject = ''
+        if (gitCommit) {
+            def indexEndOfLine = gitCommit.indexOf('\n')
+            gitCommitSubject = gitCommit[0..indexEndOfLine]
+        } else {
+            gitCommitSubject = getCommitSubject()
+        }
+
+        gitCommitSubject = gitCommitSubject.toLowerCase().replaceAll('[\\s\\-\\_]', '')
+
+        return (gitCommitSubject.contains('[ciskip]')
+                 || gitCommitSubject.contains('[skipci]')
+                 || gitCommitSubject.contains('***noci***'))
     }
 
     void checkout(String gitCommit, def userRemoteConfigs) {

test/groovy/org/ods/services/GitServiceSpec.groovy

@@ -18,5 +18,24 @@ class GitServiceSpec extends SpecHelper {
         then:
         releaseBranch == "release/0.0.1"
     }
-}
 
+    def "git skipping commit message"() {
+        given:
+        def script = new PipelineScript()
+        def service = new GitService(script, new Logger(script, false))
+
+        when:
+        def result = service.isCiSkipInCommitMessage(gitCommitMessage)
+
+        then:
+        result == isSkippingCommitMessage
+
+        where:
+        gitCommitMessage                             || isSkippingCommitMessage
+        'docs: update README [ci skip]'              || true
+        'docs: update README [skip ci]'              || true
+        'docs: update README ***NO_CI***'            || true
+        'docs: update README'                        || false
+        'docs: update README\n\n- typo\n- [ci skip]' || false
+    }
+}