如何向Jenkins Pipeline添加超时步骤

使用自由样式项目时，您可以设置20分钟后，如果未结束，则中止构建。Jenkins多分支管道项目如何做到这一点？

您可以使用超时步骤：

timeout(20) {
  node {
    sh 'foo'
  }
}

如果你需要一个不同的TimeUnit比MINUTES，您可以提供的unit参数：

timeout(time: 20, unit: 'SECONDS') {

编辑2018年8月：如今，使用更常见的声明性管道（易于被顶层pipeline构造识别），还可以options在不同级别（每个整体管道或每个阶段）使用指定超时：

pipeline {
  options {
      timeout(time: 1, unit: 'HOURS') 
  }
  stages { .. }
  // ..
}

不过，如果要将超时应用于声明式管道中的单个步骤，则可以如上所述使用超时。

对于声明性管道，建议在options-section中使用超时步骤。

以确定的超时限制执行块内的代码。如果达到了时间限制，则会引发异常（org.jenkinsci.plugins.workflow.steps.FlowInterruptedException），这将导致构建中止（除非以某种方式捕获并处理了该构建）。单位是可选的，但默认为分钟。

超时步骤有3个参数可以配置：

• 时间（必填，整数）

  • 超时量（如果未指定单位），以分钟为单位的持续时间

• 活动（可选，布尔值）

  • 此块的日志中没有活动之后的超时，而不是绝对持续时间。

• 单位（可选，值：NANOSECONDS，MICROSECONDS，MILLISECONDS，SECONDS，MINUTES，HOURS，DAYS）

  • 时间单位，默认为MINUTES

例子：

timeout(time: 10) // would lead to a timeout of 10 minutes (MINUTES is default value)
timeout(time: 10, unit: 'SECONDS') // a 10 seconds timeout
timeout(time: 10, activity: false, unit: 'MILLISECONDS')

该负责人詹金斯文档具有使用超时的一个很好的例子：

pipeline {
    agent any
    options {
        timeout(time: 1, unit: 'HOURS') 
    }
    stages {
        stage('Example') {
            steps {
                echo 'Hello World'
            }
        }
    }
}