Build timeouts in Jenkins - Step-by-Step Execution

Process Flow - Build timeouts

Start Build

↓

Start Timer

↓

Build Running

↓

Check Timeout?

No→Continue Build

Yes↓

Abort Build

↓

Build Ends

The build starts and a timer runs. If the build runs longer than the timeout, Jenkins aborts it. Otherwise, it continues until done.

Execution Sample

Jenkins

timeout(time: 5, unit: 'MINUTES') {
  sh 'sleep 300'
}

This Jenkins pipeline snippet runs a shell command that sleeps for 300 seconds with a 5-minute timeout.

Process Table

Step	Action	Timer Status	Build Status	Output
1	Start build and timer	0 min elapsed	Running	Build started
2	Run shell command 'sleep 300'	1 min elapsed	Running	Sleeping...
3	Run shell command continues	4 min elapsed	Running	Still sleeping...
4	Timer reaches 5 minutes	5 min elapsed	Timeout triggered	Build aborted due to timeout
5	Build ends	Stopped	Aborted	Build stopped because timeout exceeded

💡 Build aborted because the timeout of 5 minutes was reached while the sleep command was still running.

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	Final
Timer (minutes elapsed)	0	0	1	4	5	Stopped
Build Status	Not started	Running	Running	Running	Timeout triggered	Aborted

Key Moments - 2 Insights

Why does the build abort exactly at 5 minutes?

Because the timeout is set to 5 minutes, Jenkins monitors the elapsed time and aborts the build as soon as it reaches this limit, as shown in step 4 of the execution table.

What happens if the build finishes before the timeout?

If the build finishes before the timeout, Jenkins stops the timer and completes the build normally. This is implied by the flow where 'Check Timeout?' leads to 'Continue Build' if no timeout occurs.

Visual Quiz - 3 Questions

Look at the execution table, what is the build status at step 3?

A Aborted

B Not started

C Running

D Completed

💡 Hint

Check the 'Build Status' column at step 3 in the execution table.

At which step does the timeout trigger the build abort?

A Step 2

B Step 4

C Step 5

D Step 3

💡 Hint

Look for 'Timeout triggered' in the 'Build Status' column in the execution table.

If the timeout was set to 10 minutes instead of 5, what would change in the execution table?

A Build would never abort at 5 minutes

B Timer would reach 10 minutes before aborting

C Build would abort at step 4

D Build would abort immediately

💡 Hint

Refer to the 'Timer Status' and 'Build Status' columns and how timeout triggers abort.

Concept Snapshot

Build timeouts in Jenkins stop builds that run too long.
Use the 'timeout' step with time and unit.
If build exceeds time, Jenkins aborts it.
Prevents stuck or slow builds.
Example: timeout(time:5, unit:'MINUTES') { ... }

Full Transcript

In Jenkins, build timeouts help stop builds that take too long. When a build starts, Jenkins starts a timer. If the build finishes before the timeout, it completes normally. If the build runs longer than the timeout, Jenkins aborts it to save resources. For example, using the 'timeout' step with 5 minutes means if the build runs over 5 minutes, Jenkins stops it. This prevents builds from hanging forever. The execution table shows the timer increasing each step and the build status changing to aborted when the timeout is reached.

Practice

1. What is the main purpose of using timeout in a Jenkins build step?

easy

A. To log the build step output for debugging

B. To increase the build step execution time automatically

C. To restart the build step if it fails

D. To limit how long a build step runs to avoid stuck builds

Solution

1. Step 1: Understand the role of timeout in Jenkins

   The timeout directive is used to set a maximum time limit for a build step to run.

2. Step 2: Identify the benefit of limiting build step time

   Limiting time prevents builds from hanging indefinitely and wasting resources.

3. Final Answer:

   To limit how long a build step runs to avoid stuck builds -> Option D

4. Quick Check:

   Timeout limits build step time = A [OK]

Hint: Timeout stops long builds to save resources [OK]

Common Mistakes:

• Thinking timeout extends build time
• Confusing timeout with retry logic
• Assuming timeout logs output automatically

2. Which of the following is the correct syntax to set a timeout of 10 minutes in a Jenkins pipeline?

easy

A. timeout(time: 10, unit: 'MINUTES') { /* steps */ }

B. timeout(10 minutes) { /* steps */ }

C. timeout { time: 10, unit: 'MINUTES' }

D. timeout(time=10, unit='minutes') { /* steps */ }

Solution

1. Step 1: Recall Jenkins timeout syntax

   The correct syntax uses named parameters: timeout(time: 10, unit: 'MINUTES').

2. Step 2: Check each option for syntax correctness

   timeout(time: 10, unit: 'MINUTES') { /* steps */ } matches the correct syntax. The other options have syntax errors or wrong parameter formats.

3. Final Answer:

   timeout(time: 10, unit: 'MINUTES') { /* steps */ } -> Option A

4. Quick Check:

   Named params with colon and quotes = B [OK]

Hint: Use named params with colon and quotes for timeout [OK]

Common Mistakes:

• Using parentheses without named params
• Wrong parameter separators like = instead of :
• Missing quotes around unit string

3. Given this Jenkins pipeline snippet:

timeout(time: 1, unit: 'MINUTES') {
  sh 'sleep 90'
}

What will happen when this pipeline runs?

medium

A. The build step will complete successfully after 90 seconds

B. The build step will timeout and be aborted after 1 minute

C. The build step will ignore the timeout and run for 90 seconds

D. The build will fail immediately due to syntax error

Solution

1. Step 1: Analyze the timeout and sleep duration

   The timeout is set to 1 minute, but the shell command sleeps for 90 seconds (1.5 minutes).

2. Step 2: Understand timeout behavior

   Since the sleep exceeds the timeout, Jenkins will abort the build step after 1 minute.

3. Final Answer:

   The build step will timeout and be aborted after 1 minute -> Option B

4. Quick Check:

   Sleep > timeout causes abort = D [OK]

Hint: If step runs longer than timeout, Jenkins aborts it [OK]

Common Mistakes:

• Assuming step completes despite timeout
• Confusing timeout unit or value
• Thinking syntax error occurs here

4. You added a timeout to your Jenkins pipeline but it does not abort the build when expected. Which is the most likely cause?

medium

A. The timeout unit is misspelled or invalid

B. The timeout block is placed outside the pipeline script

C. The timeout value is set longer than the step duration

D. The Jenkins server is offline

Solution

1. Step 1: Check timeout configuration

   The most likely cause is that the timeout value is set longer than the actual step duration, so no timeout occurs even if expected.

2. Step 2: Evaluate other options

   Timeout block outside pipeline or invalid unit would cause syntax errors preventing execution. Server offline prevents builds from running.

3. Final Answer:

   The timeout value is set longer than the step duration -> Option C

4. Quick Check:

   Timeout value longer than step = A [OK]

Hint: Verify timeout value vs step duration if no abort [OK]

Common Mistakes:

• Placing timeout outside pipeline block
• Setting timeout longer than step time expecting abort
• Ignoring Jenkins server status

5. You want to ensure a Jenkins build step is aborted if it runs longer than 5 minutes, but you also want to retry the step up to 2 times if it fails due to timeout. Which pipeline snippet correctly implements this?

hard

A. retry(2) {
timeout(time: 5, unit: 'MINUTES') {
sh 'run-step.sh'
}
}

B. timeout(time: 5, unit: 'MINUTES') {
retry(2) {
sh 'run-step.sh'
}
}

C. timeout(time: 5, unit: 'MINUTES', retry: 2) {
sh 'run-step.sh'
}

D. retry(2, timeout(time: 5, unit: 'MINUTES')) {
sh 'run-step.sh'
}

Solution

1. Step 1: Understand retry and timeout nesting

   To retry a step if it times out, the timeout block must be inside the retry block so the whole timeout step is retried.

2. Step 2: Evaluate each option's structure

   retry(2) { timeout(time: 5, unit: 'MINUTES') { sh 'run-step.sh' } } correctly nests timeout inside retry. timeout(time: 5, unit: 'MINUTES') { retry(2) { sh 'run-step.sh' } } retries the inner command but timeout applies only once. The remaining options use invalid syntax.

3. Final Answer:

   retry(2) { timeout(time: 5, unit: 'MINUTES') { sh 'run-step.sh' } } -> Option A

4. Quick Check:

   retry outside timeout retries whole timeout block = A [OK]

Hint: Put timeout inside retry to retry timed-out steps [OK]

Common Mistakes:

• Placing retry inside timeout causing no retry on timeout
• Using invalid parameters in timeout
• Misunderstanding retry scope