评论可能在一个詹金斯档案?如果是,语法是什么?
我使用的是声明式管道语法。
我想注释掉下面的“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."
}
}
}
注释在任何常见的Java/Groovy表单中都可以很好地工作,但是目前不能使用groovydoc来处理Jenkinsfile。
首先,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风格的注释会被忽略。所以即使你复制/重命名你的詹金斯文件。Groovy,您不会得到太多有用的输出。
我希望能够使用a
/**
* Document my Jenkinsfile's overall purpose here
*/
评论在我的詹金斯档案开始。(目前)还没有这样的运气。
不过,如果将-private传递给命令,groovydoc将处理在Jenkinsfile中定义的类和方法。
注释在任何常见的Java/Groovy表单中都可以很好地工作,但是目前不能使用groovydoc来处理Jenkinsfile。
首先,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风格的注释会被忽略。所以即使你复制/重命名你的詹金斯文件。Groovy,您不会得到太多有用的输出。
我希望能够使用a
/**
* Document my Jenkinsfile's overall purpose here
*/
评论在我的詹金斯档案开始。(目前)还没有这样的运气。
不过,如果将-private传递给命令,groovydoc将处理在Jenkinsfile中定义的类和方法。
您可以对每一行使用块(/***/)或单行注释(//)。sh命令中应使用“#”。
块注释
/*
{后
成功{
邮寄至“XXXXX@gmail.com”,
主题:“成功:$ {currentBuild.fullDisplayName}”,
身体:“耶,我们通过了。”
}
{失败
邮寄至“XXXXX@gmail.com”,
主题:“失败:$ {currentBuild.fullDisplayName}”,
身体:“嘘,我们失败了。”
}
}
* /
一行
// post {
// success {
//邮件到:“XXXXX@gmail.com”,
// subject:"SUCCESS: ${currentBuild.fullDisplayName}",
// body:“耶,我们通过了。”
/ /}
//失败{
//邮件到:“XXXXX@gmail.com”,
// subject:"FAILURE: ${currentBuild.fullDisplayName}",
// body: "Boo, we failed."
/ /}
/ /}
在'sh'命令中注释
stage(“单元测试”){
{步骤
ansiColor (xterm) {
sh”
npm测试
#这是sh中的注释
“‘
}
}
}
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 */
or
/**
* such a nice comment
*/