Jenkins dosyasına yorum eklenebilir mi?

Jenkins dosyasında yorum yapmak mümkün mü? Eğer öyleyse, sözdizimi nedir?

Bildirimsel boru hattı sözdizimini kullanıyorum.

SMTP sunucum çalışana kadar aşağıdaki "post" bölümünü yorumlamak istiyorum.

pipeline {

  agent { label 'docker-build-slave' }

  environment {
    IMAGE = 'registry.gitlab.com/XXXXX/bible-server'
    DOCKER_REGISTRY_CREDENTIALS = credentials('DOCKER_REGISTRY_CREDENTIALS')
  }

  options {
    timeout(10)
  }

  stages {

    stage('Test') {
      steps {
        sh 'yarn'
        sh 'npm test'
      }
    }

    stage('Build') {
      when {
        branch '*/master'
      }
      steps {
        sh 'docker login -u ${DOCKER_REGISTRY_CREDENTIALS_USR} -p ${DOCKER_REGISTRY_CREDENTIALS_PSW} registry.gitlab.com'
        sh 'docker build -t ${IMAGE}:${BRANCH_NAME} .'
        sh 'docker push ${IMAGE}:${BRANCH_NAME}'
      }
    }

    stage('Deploy') {
      when {
        branch '*/master'
      }
      steps {
        echo 'Deploying ..'
      }
    }
  }

  post {
    success {
      mail to: "XXXXX@gmail.com", subject:"SUCCESS: ${currentBuild.fullDisplayName}", body: "Yay, we passed."
    }
    failure {
      mail to: "XXXXX@gmail.com", subject:"FAILURE: ${currentBuild.fullDisplayName}", body: "Boo, we failed."
    }
  }
}
Vadim Kotov
Edited question 2018ööp32öö11 Mart 2018 в 11:32
Programlama
comments groovy jenkins jenkins-pipeline
2017ööp11öö1 Şubat 2017 в 1:11
77 görünümler
Çözüm

Jenkinsfile, Java (ve C) yorum biçimini kullanan groovy ile yazılmıştır:

/* this
   is a
   multi-line comment */

// this is a single line comment
Yorumlar (2)

Her satır için blok (/***/) veya tek satır yorum (//) kullanabilirsiniz. sh komutunda "#" kullanmalısınız.

Yorumu engelle

/*  
post {
    success {
      mail to: "XXXXX@gmail.com", 
      subject:"SUCCESS: ${currentBuild.fullDisplayName}", 
      body: "Yay, we passed."
    }
    failure {
      mail to: "XXXXX@gmail.com", 
      subject:"FAILURE: ${currentBuild.fullDisplayName}", 
      body: "Boo, we failed."
    }
  }
*/

Tek Hat

// post {
//     success {
//       mail to: "XXXXX@gmail.com", 
//       subject:"SUCCESS: ${currentBuild.fullDisplayName}", 
//       body: "Yay, we passed."
//     }
//     failure {
//       mail to: "XXXXX@gmail.com", 
//       subject:"FAILURE: ${currentBuild.fullDisplayName}", 
//       body: "Boo, we failed."
//     }
// }

'sh' komutunda yorum

        stage('Unit Test') {
            steps {
                ansiColor('xterm'){
                  sh '''
                  npm test
                  # this is a comment in sh
                  '''
                }
            }
        }
Yorumlar (0)

Yorumlar her zamanki Java/Groovy formlarının herhangi birinde iyi çalışır, ancak şu anda Jenkinsfile (lar) ınızı işlemek için groovydoc kullanamazsınız.

İlk olarak, groovydoc uzantısı olmayan dosyalarda harika bir hata ile tıkanıyor

java.lang.reflect.InvocationTargetException
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:498)
    at org.codehaus.groovy.tools.GroovyStarter.rootLoader(GroovyStarter.java:109)
    at org.codehaus.groovy.tools.GroovyStarter.main(GroovyStarter.java:131)
Caused by: java.lang.StringIndexOutOfBoundsException: String index out of range: -1
    at java.lang.String.substring(String.java:1967)
    at org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDocAssembler.(SimpleGroovyClassDocAssembler.java:67)
    at org.codehaus.groovy.tools.groovydoc.GroovyRootDocBuilder.parseGroovy(GroovyRootDocBuilder.java:131)
    at org.codehaus.groovy.tools.groovydoc.GroovyRootDocBuilder.getClassDocsFromSingleSource(GroovyRootDocBuilder.java:83)
    at org.codehaus.groovy.tools.groovydoc.GroovyRootDocBuilder.processFile(GroovyRootDocBuilder.java:213)
    at org.codehaus.groovy.tools.groovydoc.GroovyRootDocBuilder.buildTree(GroovyRootDocBuilder.java:168)
    at org.codehaus.groovy.tools.groovydoc.GroovyDocTool.add(GroovyDocTool.java:82)
    at org.codehaus.groovy.tools.groovydoc.GroovyDocTool$add.call(Unknown Source)
    at org.codehaus.groovy.runtime.callsite.CallSiteArray.defaultCall(CallSiteArray.java:48)
    at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:113)
    at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:125)
    at org.codehaus.groovy.tools.groovydoc.Main.execute(Main.groovy:214)
    at org.codehaus.groovy.tools.groovydoc.Main.main(Main.groovy:180)
    ... 6 more

... ve ikinci olarak, söyleyebileceğim kadarıyla bir groovy betiğinin başlangıcındaki Javadoc tarzı yorumlar göz ardı ediliyor. Yani Jenkinsfile dosyanızı Jenkinsfile.groovy olarak kopyalasanız/adını değiştirseniz bile, pek yararlı bir çıktı elde edemezsiniz.

Kullanabilmek istiyorum

/**
 * Document my Jenkinsfile's overall purpose here
 */

Jenkins dosyamın başındaki yorum. Böyle bir şans yok (henüz).

Yine de komuta -private değerini geçerseniz groovydoc *Jenkinsfile` içinde tanımlanmış sınıfları ve yöntemleri işleyecektir.

Yorumlar (0)