È possibile aggiungere commenti a un file Jenkins?


177

I commenti sono possibili in un file Jenkins? In tal caso, qual è la sintassi?

Sto usando la sintassi della pipeline dichiarativa.

Voglio commentare la sezione "post" di seguito fino a quando il mio server SMTP non funziona.

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
Ogni volta che hai domande linguistiche su Jenkinsfiles, ricorda che sono per lo più script GROOVY. Quindi è possibile trovare più risultati se aggiungi la parola chiave "groovy" anziché "Jenkinsfile".
Raúl Salinas-Monteagudo,

Risposte:


284

Il file Jenkins è scritto in modo groovy che utilizza la forma di commenti Java (e C):

/* this
   is a
   multi-line comment */

// this is a single line comment

3
Sto usando una pipeline dichiarativa su un file jenkins all'interno di una sezione sh e non funziona, forse funziona a livello di blocco. 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} */ ''' < provoca un errore / errore di autorizzazione bash
Chen

6
All'interno di una shsezione, è necessario utilizzare il carattere di commento della shell:#
BMitch

18

È possibile utilizzare il blocco (/ *** /) o il commento a riga singola (//) per ogni riga. Dovresti usare "#" nel comando sh.

Blocca commento

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

Linea singola

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

Commenta nel comando 'sh'

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


1

I commenti funzionano bene in uno dei soliti moduli Java / Groovy, ma al momento non è possibile utilizzarli groovydocper elaborare i propriJenkinsfile .

Innanzitutto, groovydocsoffoca sui file senza estensioni con l'errore meraviglioso

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

... e in secondo luogo, per quanto ne so, i commenti in stile Javadoc all'inizio di una groovysceneggiatura vengono ignorati. Quindi, anche se si copia / rinominare la Jenkinsfilea Jenkinsfile.groovy, non sarà possibile ottenere molto di potenza utile.

Voglio essere in grado di usare a

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

commento all'inizio del mio file Jenkins. Nessuna fortuna (ancora).

groovydoc sarà elaborare le classi ei metodi definiti nella vostra Jenkinsfilese si passa -privateal comando, però.


1

La documentazione ufficiale di Jenkins menziona solo comandi a riga singola come il seguente:

// Declarative //

e ( vedi )

pipeline {
    /* insert Declarative Pipeline here */
}

La sintassi del file Jenkins si basa su Groovy, quindi è anche possibile utilizzare la sintassi groovy per i commenti . Citazione:

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

o

/**
 * such a nice comment
 */
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.