Des commentaires peuvent-ils être ajoutés à un fichier Jenkins?


177

Les commentaires sont-ils possibles dans un Jenkinsfile? Si oui, quelle est la syntaxe?

J'utilise la syntaxe déclarative du pipeline.

Je souhaite commenter la section «post» ci-dessous jusqu'à ce que mon serveur SMTP fonctionne.

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
Chaque fois que vous avez de telles questions linguistiques sur Jenkinsfiles, rappelez-vous simplement qu'il s'agit principalement de scripts GROOVY. Il est donc possible que vous trouviez plus de résultats si vous ajoutez le mot-clé "groovy" plutôt que "Jenkinsfile".
Raúl Salinas-Monteagudo

Réponses:


285

Le Jenkinsfile est écrit en groovy qui utilise la forme Java (et C) des commentaires:

/* this
   is a
   multi-line comment */

// this is a single line comment

3
J'utilise un pipeline déclaratif sur un fichier jenkins à l'intérieur d'une section sh et cela échoue, peut-être que cela fonctionne au niveau du bloc. 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} */ ''' < entraîne une erreur d'autorisations d'erreur / bash
Chen

6
À l'intérieur d'une shsection, vous devez utiliser le caractère de commentaire du shell:#
BMitch

18

Vous pouvez utiliser un bloc (/ *** /) ou un commentaire sur une seule ligne (//) pour chaque ligne. Vous devez utiliser "#" dans la commande sh.

Bloquer le commentaire

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

Une seule ligne

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

Commentaire dans la commande 'sh'

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


1

Les commentaires fonctionnent correctement dans toutes les formes Java / Groovy habituelles, mais vous ne pouvez pas actuellement utiliser groovydocpour traiter votreJenkinsfile ( ).

Tout d'abord, groovydocs'étouffe sur les fichiers sans extensions avec la merveilleuse erreur

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

... et deuxièmement, pour autant que je sache, les commentaires de style Javadoc au début d'un groovyscript sont ignorés. Ainsi, même si vous copiez / renommez votre Jenkinsfileen Jenkinsfile.groovy, vous n'obtiendrez pas beaucoup de résultats utiles.

Je veux pouvoir utiliser un

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

commentaire au début de mon Jenkinsfile. Pas de chance (encore).

groovydoc va traiter les classes et méthodes définies dans votre Jenkinsfilesi vous passez -privateà la commande, cependant.


1

La documentation officielle de Jenkins ne mentionne que des commandes sur une seule ligne comme les suivantes:

// Declarative //

et ( voir )

pipeline {
    /* insert Declarative Pipeline here */
}

La syntaxe du Jenkinsfile est basée sur Groovy , il est donc également possible d'utiliser la syntaxe groovy pour les commentaires . Citation:

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

ou

/**
 * such a nice comment
 */
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.