Können Kommentare zu einer Jenkins-Datei hinzugefügt werden?


177

Sind Kommentare in einer Jenkins-Datei möglich? Wenn ja, wie lautet die Syntax?

Ich verwende die deklarative Pipeline-Syntax.

Ich möchte den Abschnitt "Post" unten auskommentieren, bis mein SMTP-Server funktioniert.

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."
    }
  }
}

2
Wenn Sie solche Sprachfragen zu Jenkinsfiles haben, denken Sie daran, dass es sich hauptsächlich um GROOVY-Skripte handelt. Es ist also möglich, dass Sie mehr Ergebnisse finden, wenn Sie das Schlüsselwort "groovy" anstelle von "Jenkinsfile" hinzufügen.
Raúl Salinas-Monteagudo

Antworten:


282

Die Jenkins-Datei ist groovig geschrieben und verwendet die Java- (und C-) Form von Kommentaren:

/* this
   is a
   multi-line comment */

// this is a single line comment

3
Ich verwende eine deklarative Pipeline für eine Jenkins-Datei innerhalb eines sh-Abschnitts und sie schlägt fehl, vielleicht funktioniert sie auf Blockebene. pipeline { ... stage('Set Tagging') { steps { sh ''' echo "env.m_time='$m_time'" > ${params_file} echo "env.m_comp_tag='${BRANCH_NAME}_${m_time}_${BUILD_NUMBER}'" >> ${params_file} /* echo "env.docker_ws='/usr/local/lib/node_modules/${repo}'" >> ${params_file} */ ''' < führt zu Fehler / Bash Berechtigungen Fehler
Chen

6
Innerhalb eines shAbschnitts müssten Sie das Shell-Kommentarzeichen verwenden:#
BMitch

18

Sie können für jede Zeile einen Block (/ *** /) oder einen einzeiligen Kommentar (//) verwenden. Sie sollten "#" im Befehl sh verwenden.

Kommentar blockieren

/*  
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."
    }
  }
*/

Einzelne Zeile

// 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."
//     }
// }

Kommentar im Befehl 'sh'

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


1

Kommentare funktionieren in allen üblichen Java / Groovy-Formularen einwandfrei, können jedoch derzeit nichtgroovydoc zur Verarbeitung Ihrer verwendet werdenJenkinsfile (n) verwendet werden.

Erstens groovydocerstickt an Dateien ohne Erweiterungen mit dem wunderbaren Fehler

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.<init>(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

... und zweitens, soweit ich das beurteilen kann, werden Kommentare im Javadoc-Stil zu Beginn eines groovySkripts ignoriert. Also selbst wenn Sie kopieren / benennen Sie Jenkinsfilezu Jenkinsfile.groovy, Sie werden nicht viel Nutzleistung bekommen.

Ich möchte in der Lage sein, a

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

Kommentar zu Beginn meiner Jenkins-Datei. Noch kein Glück.

groovydoc wird verarbeitet in Ihrer definierten Klassen und Methoden , Jenkinsfilewenn Sie passieren -privateauf den Befehl, though.


1

In der offiziellen Jenkins-Dokumentation werden nur einzeilige Befehle wie die folgenden erwähnt:

// Declarative //

und ( siehe )

pipeline {
    /* insert Declarative Pipeline here */
}

Die Syntax der Jenkins-Datei basiert auf Groovy, sodass auch die Groovy-Syntax für Kommentare verwendet werden kann . Zitat:

/* a standalone multiline comment
   spanning two lines */
println "hello" /* a multiline comment starting
                   at the end of a statement */
println 1 /* one */ + 2 /* two */

oder

/**
 * such a nice comment
 */
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.