如何向Jenkins Pipeline添加超时步骤

Question

当您使用自由风格项目时，您可以设置在20分钟后，如果未结束，则中止生成。Jenkins多分支管道项目如何实现这一点？

Answer 1

在声明式管道中，您可以使用：

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                retry(3) {
                    sh './flakey-deploy.sh'
                }

                timeout(time: 3, unit: 'MINUTES') {
                    sh './health-check.sh'
                }
            }
        }
    }
}

Answer 2

对于声明性管道，建议在选项部分使用超时步骤。

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

timeout-Step有3个参数可以配置：

>

时间（必需，int）

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

活动（可选，布尔）

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

单位（可选，值：纳秒、微秒、毫秒、秒、分钟、小时、天）

• 时间单位默认为分钟

例子：

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')

Jenkins官方文档中有一个很好的超时使用示例：

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

Answer 3

您可以使用超时步骤：

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

如果需要不同于分钟的时间单位，可以提供参数：

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

2018年8月编辑：如今，随着更常见的声明性管道（很容易被顶级管道构造识别），也可以在不同级别（每个整体管道或每个阶段）使用选项指定超时：

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

不过，如果您想对声明性管道中的单个步骤应用超时，可以如上所述使用它。