Jenkins:Jenkinsfile中是否可以添加注释?

249

在Jenkinsfile中是否可以添加注释?如果可以,那么语法是什么?

我正在使用声明性流水线语法。

我想将下面的“post”部分注释掉,直到我的SMTP服务器正常工作为止。

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

4
如果您对Jenkinsfile有语言方面的问题,记住它们基本上是GROOVY脚本。因此,如果您添加关键字"groovy"而不是"Jenkinsfile",可能会找到更多结果。 - Raúl Salinas-Monteagudo
4个回答

387

Jenkinsfile是使用Groovy编写的,它使用Java(和C)风格的注释:

/* this
   is a
   multi-line comment */

// this is a single line comment

3
我正在一个 sh 段落内使用 Jenkinsfile 中的声明性流水线,但它失败了,也许在块级别上可以工作。pipeline { ... stage('设置标记') { 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} */ ''' < `导致错误 /bash 权限错误。 - Chen
9
在一个 sh 部分中,您需要使用 shell 注释符号:# - BMitch

36
您可以使用块注释(/***/)或单行注释(//)来注释每一行。在 sh 命令中应该使用 "#"。

Block comment

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

Single Line

// 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'命令中的注释

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


啊,谢谢。我忘了我是在扩展的sh块中工作。 - Ilion

4

Jenkins官方文档仅提到以下单行命令:

// Declarative //

并且(查看

pipeline {
    /* insert Declarative Pipeline here */
}

Jenkinsfile的语法基于Groovy,因此也可以使用 Groovy语法进行注释。引用:
/* a standalone multiline comment
   spanning two lines */
println "hello" /* a multiline comment starting
                   at the end of a statement */
println 1 /* one */ + 2 /* two */

或者

/**
 * such a nice comment
 */

1

评论在任何通常的Java/Groovy表单中都可以正常工作,但是您目前无法使用groovydoc处理您的Jenkinsfile(s)。

首先,groovydoc会出现精彩的错误,无法处理没有扩展名的文件。

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

首先,据我所知,在groovy脚本开头使用Javadoc风格的注释会被忽略。因此,即使你将Jenkinsfile复制/重命名为Jenkinsfile.groovy,也不会得到太多有用的输出。其次,我希望能够使用一个

(未提供完整句子或上下文)。
/**
 * Document my Jenkinsfile's overall purpose here
 */

我在Jenkinsfile开头添加了注释,但没有成功(至少目前还没有成功)。

groovydoc可以处理你在Jenkinsfile中定义的类和方法,只需在命令中传递-private参数即可。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接