Workspace cleanup in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is workspace cleanup in Jenkins?

Workspace cleanup is the process of removing files and folders from the Jenkins job workspace to ensure a clean environment for new builds.

beginner

Why is workspace cleanup important in Jenkins?

It prevents old files from interfering with new builds, saves disk space, and avoids build errors caused by leftover data.

intermediate

Which Jenkins plugin helps automate workspace cleanup?

The 'Workspace Cleanup Plugin' helps automate cleaning the workspace before or after a build.

intermediate

How do you configure workspace cleanup in a Jenkins Pipeline script?

Use the 'cleanWs()' step inside the pipeline script to delete workspace files before or after build steps.

beginner

What is the effect of adding 'Delete workspace before build starts' in Jenkins job settings?

It removes all files in the workspace before the build runs, ensuring a fresh start for the build process.

What does the 'cleanWs()' step do in a Jenkins Pipeline?

A Restarts Jenkins server

B Starts a new build

C Saves workspace files

D Deletes all files in the workspace

The 'cleanWs()' step deletes all files in the workspace to clean it.

Why should you clean the workspace before a build?

A To avoid conflicts from leftover files

B To speed up the build by keeping old files

C To save build logs

D To backup workspace data

Cleaning avoids conflicts caused by leftover files from previous builds.

Which Jenkins plugin is commonly used for workspace cleanup?

A Git Plugin

B Workspace Cleanup Plugin

C Docker Plugin

D Email Extension Plugin

The Workspace Cleanup Plugin automates cleaning workspace files.

Where can you enable 'Delete workspace before build starts' in Jenkins?

A In global Jenkins settings

B In Jenkins user profile

C In job configuration settings

D In Jenkins system logs

This option is set in the job's configuration page.

What happens if workspace cleanup is skipped?

A Old files may cause build failures

B Jenkins server restarts

C Builds run faster

D Workspace size decreases

Skipping cleanup can cause build errors due to leftover files.

Explain how workspace cleanup improves Jenkins build reliability.

Think about what leftover files can do to a new build.

Describe how to implement workspace cleanup in a Jenkins Pipeline script.

Focus on the pipeline syntax and plugin needed.

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