Jak dodać krok limitu czasu do Jenkins Pipeline

Jeśli używasz projektu w dowolnym stylu, możesz ustawić, że po 20 minutach kompilacja zostanie przerwana, jeśli nie zostanie zakończona. Jak jest to możliwe w przypadku projektu Jenkins Multi Branch Pipeline?

Możesz użyć kroku limitu czasu :

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

Jeśli potrzebujesz wartości innej TimeUnitniż MINUTY , możesz podać unitargument:

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

EDYCJA, sierpień 2018 r .: Obecnie, w przypadku bardziej powszechnych potoków deklaratywnych (łatwo rozpoznawalnych przez konstrukcję najwyższego poziomu pipeline), limity czasu można również określić przy użyciu optionsróżnych poziomów (na ogólny potok lub na etap):

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

Jeśli jednak chcesz zastosować limit czasu do pojedynczego kroku w potoku deklaratywnym, możesz go użyć w sposób opisany powyżej.

W przypadku potoku deklaratywnego zaleca się użycie kroku limitu czasu w sekcji opcji .

Wykonuje kod wewnątrz bloku z określonym limitem czasu. Po osiągnięciu limitu czasu wyrzucany jest wyjątek (org.jenkinsci.plugins.workflow.steps.FlowInterruptedException), który prowadzi do przerwania kompilacji (chyba że zostanie w jakiś sposób przechwycony i przetworzony). Jednostka jest opcjonalna, ale domyślnie są to minuty.

Krok limitu czasu ma 3 parametry, które możesz skonfigurować:

• czas (wymagane, int)

  • Długość limitu czasu, jeśli żadna jednostka nie jest podana w minutach

• aktywność (opcjonalna, boolowska)

  • Limit czasu po braku aktywności w dziennikach dla tego bloku zamiast bezwzględnego czasu trwania.

• jednostka (opcjonalnie, wartości: NANOSECONDS, MICROSECONDS, MILISECONDS, SECONDS, MINUTES, HOURS, DAYS)

  • Jednostką czasu , domyślnie są MINUTY

Przykłady:

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

Oficjalna dokumentacja Jenkins ma bardzo ładny przykład dla wykorzystania timeout:

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