Как добавить шаг тайм-аута в Jenkins Pipeline

Когда вы используете проект в свободном стиле, вы можете установить, что через 20 минут сборка будет прервана, если не будет завершена. Как это возможно с проектом Jenkins Multi Branch Pipeline?

Вы можете использовать шаг тайм-аута :

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

Если вам нужно значение, отличное TimeUnitот MINUTES , вы можете указать unitаргумент:

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

ИЗМЕНИТЬ август 2018: В настоящее время с более распространенными декларативными конвейерами (легко распознаваемыми конструкцией верхнего уровня pipeline) таймауты также могут быть указаны с использованием optionsна разных уровнях (для общего конвейера или для каждого этапа):

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

Тем не менее, если вы хотите применить тайм-аут к одному шагу в декларативном конвейере, его можно использовать, как описано выше.

Для декларативного конвейера рекомендуется использовать шаг тайм-аута в разделе параметров .

Выполняет код внутри блока с заданным пределом времени ожидания. Если лимит времени достигнут, генерируется исключение (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException), которое приводит к прерыванию сборки (если только оно не будет каким-то образом поймано и обработано). Единица измерения не является обязательной, но по умолчанию используется минуты.

Шаг тайм-аута имеет 3 параметра, которые вы можете настроить:

• время (обязательное, целое)

  • Время ожидания, если не указана единица времени в минутах

• активность (необязательный, логический)

  • Тайм-аут после отсутствия активности в журналах для этого блока вместо абсолютной продолжительности.

• единица измерения (необязательно, значения: НАНОСЕКУНД, МИКРОСЕКУНД, МИЛЛИСЕКУНД, СЕКУНД, МИНУТЫ, ЧАСЫ, ДНИ)

  • Единица измерения времени , по умолчанию - МИНУТЫ.

Примеры:

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