Workspace cleanup in Jenkins - Step-by-Step Execution

Process Flow - Workspace cleanup

Start Build

↓

Build Workspace Created

↓

Build Steps Execute

↓

Workspace Cleanup Triggered?

No→Keep Workspace

Yes↓

Delete Workspace Files

↓

Workspace Clean

↓

Build Ends

The workspace is created for a build, build steps run, then optionally the workspace is cleaned by deleting files before the build ends.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building...'
      }
    }
  }
  post {
    always {
      cleanWs()
    }
  }
}

This Jenkins pipeline runs a build stage and always cleans the workspace after the build finishes.

Process Table

Step	Action	Workspace State	Output
1	Start build	Empty	Build started
2	Create workspace	Workspace folder created	Workspace ready
3	Run build steps	Files created in workspace	Building...
4	Post build: cleanWs() called	Workspace files deleted	Workspace cleaned
5	Build ends	Workspace empty	Build finished

💡 Build ends after workspace cleanup, workspace is empty for next build

Status Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
Workspace State	Empty	Created	Files present	Cleaned (empty)	Empty

Key Moments - 2 Insights

Why do we clean the workspace after the build?

Cleaning the workspace removes leftover files from previous builds, preventing conflicts or errors in future builds. See execution_table step 4 where cleanWs() deletes files.

What happens if we skip cleanWs()?

The workspace keeps files from previous builds, which might cause unexpected behavior. In execution_table, skipping step 4 means workspace still has files at build end.

Visual Quiz - 3 Questions

Look at the execution table, what is the workspace state after step 3?

A Empty

B Created but empty

C Files present

D Deleted

💡 Hint

Check the 'Workspace State' column at step 3 in the execution_table

At which step does the workspace get cleaned?

A Step 4

B Step 3

C Step 2

D Step 5

💡 Hint

Look for 'cleanWs() called' in the 'Action' column of execution_table

If cleanWs() is not called, what will be the workspace state at build end?

A Empty

B Files present

C Workspace deleted

D Workspace locked

💡 Hint

Refer to key_moments about skipping cleanWs() and its effect on workspace state

Concept Snapshot

Jenkins workspace cleanup:
- Workspace holds files during build
- Use cleanWs() in post section to delete files
- Keeps builds isolated and clean
- Prevents leftover file issues
- Always clean workspace after build

Full Transcript

In Jenkins, each build runs in a workspace folder where files are created. After the build steps finish, it is important to clean the workspace to remove leftover files. This is done by calling cleanWs() in the post section of the pipeline. The flow starts with an empty workspace, files are created during build, then cleanWs() deletes these files before the build ends. This prevents conflicts in future builds by ensuring a fresh workspace each time.

Practice

1. What is the main purpose of workspace cleanup in Jenkins?

easy

A. To increase the number of concurrent builds

B. To remove old files and keep the build environment clean

C. To backup build artifacts automatically

D. To speed up the Jenkins server startup

Solution

1. Step 1: Understand workspace cleanup concept

   Workspace cleanup removes files from previous builds to avoid clutter and errors.

2. Step 2: Identify the main benefit

   Removing old files keeps the build environment clean and prevents conflicts or disk space issues.

3. Final Answer:

   To remove old files and keep the build environment clean -> Option B

4. Quick Check:

   Workspace cleanup = remove old files [OK]

Hint: Workspace cleanup deletes old build files to keep space free [OK]

Common Mistakes:

• Thinking it speeds up Jenkins server startup
• Confusing cleanup with backup
• Assuming it increases build concurrency

2. Which of the following is the correct syntax to clean the workspace in a Jenkins Pipeline script?

easy

A. cleanWs()

B. cleanWorkspace()

C. deleteWorkspace()

D. removeWs()

Solution

1. Step 1: Recall Jenkins Pipeline workspace cleanup function

   The correct function to clean workspace is cleanWs().

2. Step 2: Verify syntax correctness

   Other options are not valid Jenkins Pipeline steps for workspace cleanup.

3. Final Answer:

   cleanWs() -> Option A

4. Quick Check:

   Jenkins workspace cleanup function = cleanWs() [OK]

Hint: Remember exact function name: cleanWs() [OK]

Common Mistakes:

• Using incorrect function names like cleanWorkspace()
• Adding parentheses incorrectly or missing them
• Confusing with other cleanup commands

3. What will be the output or effect of this Jenkins Pipeline snippet?

pipeline {
  agent any
  stages {
    stage('Clean') {
      steps {
        cleanWs()
      }
    }
  }
}

medium

A. Fails with a syntax error due to missing parameters

B. Prints the workspace contents without deleting anything

C. Archives the workspace files for later use

D. Deletes all files in the current workspace before the build

Solution

1. Step 1: Analyze the cleanWs() step in the pipeline

   The cleanWs() step deletes all files in the current workspace.

2. Step 2: Understand the pipeline effect

   Since it is in the 'Clean' stage, it removes workspace files before further build steps.

3. Final Answer:

   Deletes all files in the current workspace before the build -> Option D

4. Quick Check:

   cleanWs() deletes workspace files [OK]

Hint: cleanWs() deletes workspace files, no parameters needed [OK]

Common Mistakes:

• Thinking cleanWs() only lists files
• Assuming cleanWs() needs parameters
• Confusing cleanWs() with archiving

4. You added cleanWs() in your Jenkins Pipeline, but the workspace is not cleaned. What is a likely cause?

medium

A. cleanWs() only cleans after the build, not before

B. cleanWs() requires additional parameters to work

C. The pipeline is running on a shared agent and workspace cleanup is disabled

D. The Jenkins server needs a restart to apply cleanWs()

Solution

1. Step 1: Understand workspace cleanup behavior on shared agents

   On shared agents, workspace cleanup may be disabled or restricted to avoid deleting others' files.

2. Step 2: Check common misunderstandings about cleanWs()

   cleanWs() works without parameters and cleans immediately; server restart is not needed.

3. Final Answer:

   The pipeline is running on a shared agent and workspace cleanup is disabled -> Option C

4. Quick Check:

   Shared agent restrictions block cleanWs() [OK]

Hint: Check agent type; shared agents may block cleanup [OK]

Common Mistakes:

• Thinking cleanWs() needs parameters
• Assuming cleanup only happens after build
• Restarting Jenkins unnecessarily

5. You want to ensure your Jenkins Pipeline cleans the workspace only after a successful build to save disk space but keep files if the build fails. How can you achieve this?

hard

A. Use post { success { cleanWs() } } block in the pipeline

B. Call cleanWs() at the start of the pipeline

C. Add cleanWs() inside the always post block

D. Configure Jenkins global settings to clean workspace on failure

Solution

1. Step 1: Understand Jenkins post-build actions

   The post block allows running steps based on build result, like success.

2. Step 2: Use conditional cleanup after successful build

   Placing cleanWs() inside post { success { ... } } cleans workspace only if build succeeds.

3. Final Answer:

   Use post { success { cleanWs() } } block in the pipeline -> Option A

4. Quick Check:

   Post success block cleans workspace conditionally [OK]

Hint: Use post { success { cleanWs() } } to clean only on success [OK]

Common Mistakes:

• Cleaning workspace at start loses files before build
• Using always block cleans even on failure
• Expecting global settings to handle conditional cleanup