Organization folders in Jenkins - Mini Project: Build & Apply

Create and Configure an Organization Folder in Jenkins

📖 Scenario: You are setting up Jenkins to organize multiple projects efficiently. Jenkins supports Organization Folders which help group related jobs automatically by scanning source code repositories.This project will guide you to create an Organization Folder in Jenkins using a simple configuration script.

🎯 Goal: Build a Jenkins pipeline script that creates an Organization Folder named MyOrgFolder which scans a GitHub organization example-org for repositories and automatically creates jobs for each repository.

📋 What You'll Learn

Create an Organization Folder named MyOrgFolder

Configure the folder to scan the GitHub organization example-org

Set the scan interval to 1 day

Use the Jenkins Job DSL or Pipeline syntax to define the folder

Print the folder name after creation

💡 Why This Matters

🌍 Real World

Organization Folders help Jenkins users manage many related projects by automatically creating jobs for each repository in a GitHub organization.

💼 Career

Knowing how to configure Organization Folders is useful for DevOps engineers and Jenkins administrators to automate CI/CD pipelines efficiently.

1

Create the Organization Folder block

Write a Jenkins pipeline script that creates an Organization Folder named MyOrgFolder using the organizationFolder step.

Jenkins

# Your code here to create an Organization Folder named MyOrgFolder

Hint

Use the organizationFolder step with the exact name 'MyOrgFolder'.

2

Configure GitHub organization source

Inside the organizationFolder('MyOrgFolder') block, add a sources block with a github source configured for the organization example-org.

Jenkins

pipeline {
    agent any
    stages {
        stage('Create Organization Folder') {
            steps {
                script {
                    organizationFolder('MyOrgFolder') {
                        // Add sources block here
                    }
                }
            }
        }
    }
}
# Your code here to add GitHub organization source for example-org

Hint

Use sources { github { repoOwner('example-org') } inside the folder block.

3

Set scan interval to 1 day

Inside the organizationFolder('MyOrgFolder') block, add a configure block to set the scan interval to 1 day (86400000 milliseconds).

Jenkins

pipeline {
    agent any
    stages {
        stage('Create Organization Folder') {
            steps {
                script {
                    organizationFolder('MyOrgFolder') {
                        sources {
                            github {
                                repoOwner('example-org')
                            }
                        }
                        // Add configure block here to set scan interval
                    }
                }
            }
        }
    }
}
# Your code here to add scan interval configuration

Hint

Use configure { node -> node / 'properties' / 'jenkins.branch.OrganizationFolderProperty' / 'interval' << '86400000' } to set the scan interval.

4

Print the folder name

Add a script step after the folder creation to print the text Created folder: MyOrgFolder.

Jenkins

pipeline {
    agent any
    stages {
        stage('Create Organization Folder') {
            steps {
                script {
                    organizationFolder('MyOrgFolder') {
                        sources {
                            github {
                                repoOwner('example-org')
                            }
                        }
                        configure { node ->
                            node / 'properties' / 'jenkins.branch.OrganizationFolderProperty' / 'interval' << '86400000'
                        }
                    }
                    // Print folder name here
                }
            }
        }
    }
}
# Your code here to print the folder name

Hint

Use println('Created folder: MyOrgFolder') to print the folder name.

Practice

1. What is the main purpose of an Organization Folder in Jenkins?

easy

A. To automatically group and manage multiple projects from source control

B. To manually create individual jobs one by one

C. To store Jenkins system configuration files

D. To run Jenkins on multiple servers

Solution

1. Step 1: Understand the role of Organization Folders

   Organization Folders scan source control and group many projects automatically.

2. Step 2: Compare options with this role

   Only To automatically group and manage multiple projects from source control describes automatic grouping and management from source control.

3. Final Answer:

   To automatically group and manage multiple projects from source control -> Option A

4. Quick Check:

   Organization Folder = automatic project grouping [OK]

Hint: Organization folders auto-group projects from repos [OK]

Common Mistakes:

• Thinking organization folders create jobs manually
• Confusing folders with Jenkins system files
• Assuming folders run Jenkins on servers

2. Which of the following is the correct way to create an Organization Folder in Jenkins UI?

easy

A. Manage Jenkins > Configure System > Add Organization Folder

B. New Item > Enter name > Select 'Organization Folder' > OK

C. Dashboard > New Job > Select 'Freestyle Project'

D. Manage Plugins > Install Organization Folder Plugin

Solution

1. Step 1: Recall how to create new items in Jenkins

   New items are created via 'New Item' on the dashboard.

2. Step 2: Identify the correct selection for Organization Folder

   Choosing 'Organization Folder' after naming is the correct step.

3. Final Answer:

   New Item > Enter name > Select 'Organization Folder' > OK -> Option B

4. Quick Check:

   Create folder via New Item > Organization Folder [OK]

Hint: Create folder via New Item, then choose Organization Folder [OK]

Common Mistakes:

• Trying to add folder in Configure System
• Selecting Freestyle Project instead of Organization Folder
• Confusing plugin installation with folder creation

3. Given an Organization Folder configured to scan a GitHub organization, what will Jenkins do when it scans the source control?

medium

A. Delete all existing jobs and create a single job for the organization

B. Fail to scan unless manually triggered each time

C. Only scan the first repository and ignore others

D. Create individual jobs for each repository found in the organization

Solution

1. Step 1: Understand scanning behavior of Organization Folders

   They scan all repositories in the source control organization and create jobs for each.

2. Step 2: Evaluate options against this behavior

   Create individual jobs for each repository found in the organization matches this automatic job creation per repo.

3. Final Answer:

   Create individual jobs for each repository found in the organization -> Option D

4. Quick Check:

   Scan creates jobs per repo automatically [OK]

Hint: Scan creates jobs for all repos found [OK]

Common Mistakes:

• Thinking it deletes all jobs
• Assuming only first repo is scanned
• Believing manual trigger is always needed

4. You created an Organization Folder but Jenkins does not show any jobs inside it after scanning. What is the most likely cause?

medium

A. Jenkins does not support Organization Folders

B. The Organization Folder plugin is not installed

C. The source control credentials are missing or incorrect

D. The Jenkins server is offline

Solution

1. Step 1: Check common reasons for empty scan results

   Missing or wrong credentials prevent Jenkins from accessing repos.

2. Step 2: Rule out other options

   Plugin must be installed to create folder; if folder exists, plugin is installed. Jenkins supports folders. Server offline would prevent all jobs, not just empty folder.

3. Final Answer:

   The source control credentials are missing or incorrect -> Option C

4. Quick Check:

   Missing credentials cause empty scan [OK]

Hint: Check credentials if folder scan shows no jobs [OK]

Common Mistakes:

• Assuming plugin is missing after folder creation
• Thinking Jenkins lacks folder support
• Blaming server offline without checking credentials

5. You want to configure an Organization Folder to scan a GitHub Enterprise server with multiple teams. Which two settings must you configure to ensure Jenkins discovers all repositories correctly?

hard

A. Set the GitHub Enterprise API endpoint and provide valid credentials

B. Enable Jenkins master node to run all jobs manually

C. Install the GitHub plugin and disable scanning

D. Configure the folder to scan only one team at a time

Solution

1. Step 1: Identify key settings for GitHub Enterprise scanning

   Jenkins needs the correct API endpoint URL and valid credentials to access the Enterprise server.

2. Step 2: Evaluate other options

   Running jobs manually or disabling scanning prevents auto-discovery. Scanning one team at a time limits coverage.

3. Final Answer:

   Set the GitHub Enterprise API endpoint and provide valid credentials -> Option A

4. Quick Check:

   API endpoint + credentials = full repo discovery [OK]

Hint: Set API endpoint and credentials for Enterprise scan [OK]

Common Mistakes:

• Disabling scanning disables discovery
• Assuming manual job runs help discovery
• Limiting scan to one team misses repos