Jenkins中sh函数的用法

在Jenkins的Pipeline中,sh函数的用法

用法一

单个命令字符串包括使用,示例如下:

groovy 复制代码
sh 'echo "Hello, Jenkins!"'

用法二

多个命令字符串包括命令列表使用,示例如下:

groovy 复制代码
sh '''
echo "Step 1"
echo "Step 2"
echo "Step 3"
'''

这种用法允许你在多行中写入Shell命令。

用法三

类似于函数调用的使用方法,示例如下:

groovy 复制代码
def myVariable = sh(script: 'echo "Hello, Jenkins!"', returnStdout: true).trim()

这种用法将Shell脚本的输出捕获到Jenkins Pipeline中的一个变量中。

入参及其含义:

  • script: 这是要执行的Shell脚本命令。它可以是单个命令字符串,也可以是包含多个命令的多行字符串。例如:script: 'echo "Hello, Jenkins!"'script: 'echo "Step 1"\necho "Step 2"\necho "Step 3"'

  • returnStatus (可选): 如果设置为true,Jenkins将返回Shell脚本的退出状态而不是默认的标准输出。通常,如果脚本成功执行,它将返回0。默认值为false。

  • returnStdout (可选): 如果设置为true,Jenkins将捕获Shell脚本的标准输出并将其返回。这样可以将脚本输出存储在一个变量中。默认值为false。

  • returnStderr (可选): 如果设置为true,Jenkins将捕获Shell脚本的标准错误输出并将其返回。默认值为false。

  • outpustFile (可选): 允许将Shell脚本的输出写入指定的文件。例如:outputFile: 'output.txt'

  • label: 可以用来指定在Jenkins构建日志中显示的自定义标签。例如:

    groovy 复制代码
    sh label: 'My Custom Label', script: 'echo "Hello, Jenkins!"'

注意:当使用多行字符串(triple-single-quoted或triple-double-quoted)时,Jenkins会按原样执行其中的内容,包括空格和缩进,因此请小心使用。

实际版本用法

jenkins中实际版本的用法参考,可以在jenkins中如下截图中查看,截图如下:

  1. 首先建一个pipeline类型的job。
  2. 然后在job中点击如下截图位置:
  3. 该页面操作如截图:

    特别注意:有些参数只能二选一,或者有冲突,这个页面也会提示的

其他用法,参考:

  1. jenkins pipeline中获取shell命令的标准输出或者状态
  2. https://stackoverflow.com/questions/36547680/how-to-do-i-get-the-output-of-a-shell-command-executed-using-into-a-variable-fro
  3. https://issues.jenkins-ci.org/browse/JENKINS-26133
  4. https://stackoverflow.com/questions/36956977/how-to-execute-a-command-in-a-jenkins-2-0-pipeline-job-and-then-return-the-stdou
相关推荐
海兰9 天前
Jina Embeddings V5 Text + Elasticsearch 9.x 本地部署指南
elasticsearch·jenkins·jina
luod9 天前
Docker 快速安装Jenkins
java·docker·jenkins
小道仙9710 天前
jenkins对接、jenkins-rest
java·servlet·jenkins·jenkins-rest
成为你的宁宁10 天前
Jenkins 自动化部署前后端分离若依项目全攻略:涵盖环境配置、Maven/Node.js 工具安装、GitLab 项目协同,及前后端构建、服务器推送与代码更新验证全步骤
node.js·自动化·gitlab·jenkins·maven
声声长乐10 天前
Jenkins + Docker 完整部署指南
ubuntu·docker·jenkins
古斯塔夫歼星炮10 天前
Dify + Jenkins 实现AI应用持续集成与自动化部署
ci/cd·jenkins·dify
优秀的颜10 天前
Elasticsearch(7.x)集成
大数据·elasticsearch·jenkins
何以不说话10 天前
CICD服务器jenkins
运维·jenkins
海兰12 天前
Elasticsearch Java 客户端(9.x)
java·elasticsearch·jenkins
海兰12 天前
Elasticsearch 9.x Java 异步客户端
java·elasticsearch·jenkins