So fügen Sie der Jenkins-Pipeline einen Timeout-Schritt hinzu

Wenn Sie ein Projekt im freien Stil verwenden, können Sie festlegen, dass der Build nach 20 Minuten abgebrochen wird, wenn er nicht abgeschlossen wird. Wie ist dies mit einem Jenkins Multi Branch Pipeline-Projekt möglich?

Sie können den Timeout- Schritt verwenden:

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

Wenn Sie eine andere TimeUnitals MINUTES benötigen , können Sie das folgende unitArgument angeben :

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

EDIT Aug 2018: Heutzutage können mit den allgemeineren deklarativen Pipelines (die vom pipelineKonstrukt der obersten Ebene leicht erkannt werden ) Zeitüberschreitungen auch optionsauf verschiedenen Ebenen (pro Gesamtpipeline oder pro Stufe) angegeben werden:

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

Wenn Sie jedoch eine Zeitüberschreitung auf einen einzelnen Schritt in einer deklarativen Pipeline anwenden möchten, können Sie diese wie oben beschrieben verwenden.

Für eine deklarative Pipeline ist es ratsam , das verwenden Timeout Schritt im Option-Abschnitt .

Führt den Code innerhalb des Blocks mit einem festgelegten Zeitlimit aus. Wenn das Zeitlimit erreicht ist, wird eine Ausnahme (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException) ausgelöst, die zum Abbruch des Builds führt (es sei denn, er wird abgefangen und irgendwie verarbeitet). Das Gerät ist optional, standardmäßig jedoch Minuten.

Der Timeout-Schritt enthält 3 Parameter, die Sie konfigurieren können:

• Zeit (erforderlich, int)

  • Die Höhe des Timeouts, wenn keine Einheit angegeben ist. Dauer in Minuten

• Aktivität (optional, boolesch)

  • Zeitüberschreitung nach keiner Aktivität in den Protokollen für diesen Block anstelle der absoluten Dauer.

• Einheit (optional, Werte: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTEN, STUNDEN, TAGE)

  • Die Standardeinstellung für die Zeit ist MINUTEN

Beispiele:

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

Die offizielle Jenkins-Dokumentation enthält ein sehr schönes Beispiel für die Verwendung einer Zeitüberschreitung:

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