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
相关推荐
诚丞成20 分钟前
ELK日志分析:Elasticsearch索引、Logstash接入与Kibana可视化
elk·elasticsearch·jenkins
元Y亨H18 小时前
宿主机 SSH 免密已通,为何 Jenkins 流水线仍报 Permission denied?
jenkins
落魄大学生之流水线上谋生计1 天前
从 Jenkins 小白到企业级交付平台
运维·jenkins
java、iOS、Vue2 天前
Maven antrun vs Jenkins 脚本组装 deb的优缺点、适用场景
java·jenkins·maven
事圆则缓4 天前
Android 使用 Jenkins 实现 CI/CD,并用 SonarQube 建立质量门禁
android·ci/cd·jenkins
Zhou1411368 天前
CICD_01_持续集成与Jenkins入门
运维·ci/cd·jenkins
大貔貅喝啤酒8 天前
Gitea+Jenkins+Docker 搭建 Node 项目 CI/CD 自动部署完整教程
ci/cd·docker·jenkins·js·gitea
guo_wen_qiang9 天前
jenkins流水线参数化配置
运维·docker·容器·jenkins·持续部署
何中应10 天前
Jenkins 如何给设置公司 Logo
运维·ci/cd·jenkins
何中应10 天前
Jenkins 如何配置工作节点
运维·ci/cd·jenkins