Global shared library configuration in Jenkins - Mini Project: Build & Apply

Global Shared Library Configuration in Jenkins

📖 Scenario: You work in a team that uses Jenkins for automation. To reuse common pipeline code, your team wants to set up a global shared library in Jenkins. This library will hold reusable scripts and steps for all Jenkins pipelines.

🎯 Goal: Learn how to configure a global shared library in Jenkins by defining its name, repository, and default version. Then, use it in a simple Jenkins pipeline.

📋 What You'll Learn

Create a global shared library configuration dictionary with exact keys and values

Add a configuration variable for the default branch of the library

Write the Jenkins pipeline code that uses the shared library

Print the pipeline script output to verify the library usage

💡 Why This Matters

🌍 Real World

Teams use global shared libraries in Jenkins to reuse common pipeline code, reducing duplication and errors.

💼 Career

Knowing how to configure and use shared libraries is essential for Jenkins pipeline developers and DevOps engineers to build scalable automation.

1

Create the global shared library configuration dictionary

Create a dictionary called global_shared_library with these exact entries: name set to "my-shared-lib", repository set to "https://github.com/example/my-shared-lib.git", and default_version set to "master".

Jenkins

# Create the global_shared_library dictionary with name, repository, and default_version
# Your code here

Hint

Use curly braces {} to create a dictionary. Use exact keys and values as strings.

2

Add a configuration variable for the default branch

Add a variable called default_branch and set it to the string "main" to represent the default branch of the shared library.

Jenkins

global_shared_library = {
    "name": "my-shared-lib",
    "repository": "https://github.com/example/my-shared-lib.git",
    "default_version": "master"
}

# Add the default_branch variable below
# Your code here

Hint

Use a simple assignment statement to create the variable default_branch.

3

Write the Jenkins pipeline code that uses the shared library

Write a string variable called pipeline_script that contains this exact Jenkins pipeline code using the shared library my-shared-lib with the default branch main:

"""
library('my-shared-lib@main')
pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                echo 'Using shared library'
            }
        }
    }
}
"""

Jenkins

global_shared_library = {
    "name": "my-shared-lib",
    "repository": "https://github.com/example/my-shared-lib.git",
    "default_version": "master"
}

default_branch = "main"

# Write the pipeline_script string with the Jenkins pipeline code below
# Your code here

Hint

Use triple quotes """ to create a multi-line string. Include the exact pipeline code inside.

4

Print the pipeline script output

Write a print statement to display the contents of the pipeline_script variable.

Jenkins

global_shared_library = {
    "name": "my-shared-lib",
    "repository": "https://github.com/example/my-shared-lib.git",
    "default_version": "master"
}

default_branch = "main"

pipeline_script = """
library('my-shared-lib@main')
pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                echo 'Using shared library'
            }
        }
    }
}
"""

# Print the pipeline_script variable below
# Your code here

Hint

Use print(pipeline_script) to show the pipeline code.

Practice

1. What is the main purpose of configuring a global shared library in Jenkins?

easy

A. To schedule Jenkins jobs automatically

B. To store Jenkins job logs centrally

C. To manage Jenkins user permissions

D. To reuse pipeline code across multiple Jenkins jobs

Solution

1. Step 1: Understand the role of shared libraries

   Shared libraries contain reusable pipeline code that can be used in many Jenkins jobs to avoid duplication.

2. Step 2: Identify the main benefit

   Reusing code saves time and ensures consistency across pipelines.

3. Final Answer:

   To reuse pipeline code across multiple Jenkins jobs -> Option D

4. Quick Check:

   Global shared library = reuse code [OK]

Hint: Global shared libraries = reusable pipeline code [OK]

Common Mistakes:

• Confusing shared libraries with job logs
• Thinking it manages user permissions
• Assuming it schedules jobs automatically

2. Which Jenkins menu path is used to configure a global shared library?

easy

A. Manage Jenkins > Manage Plugins

B. Manage Jenkins > Configure System

C. New Item > Pipeline

D. Dashboard > Build History

Solution

1. Step 1: Locate global shared library settings

   Global shared libraries are configured under the Jenkins system settings.

2. Step 2: Identify the correct menu path

   The correct path is Manage Jenkins > Configure System where global settings are managed.

3. Final Answer:

   Manage Jenkins > Configure System -> Option B

4. Quick Check:

   Configure System = global settings [OK]

Hint: Global settings are under Configure System [OK]

Common Mistakes:

• Choosing Manage Plugins which is for plugins only
• Selecting New Item which creates jobs
• Picking Build History which shows past builds

3. Given this Jenkinsfile snippet:

@Library('utils') _
pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        script {
          echo utils.sayHello()
        }
      }
    }
  }
}

What does @Library('utils') do here?

medium

A. Runs a plugin named 'utils' before the pipeline starts

B. Defines a new library called 'utils' inside the pipeline

C. Imports the shared library named 'utils' for use in the pipeline

D. Specifies the pipeline agent type as 'utils'

Solution

1. Step 1: Understand the @Library annotation

   The @Library('utils') annotation imports the global shared library named 'utils' so its code can be used in the pipeline.

2. Step 2: Confirm usage in the pipeline

   The pipeline calls a function from the 'utils' library, showing it is imported for use.

3. Final Answer:

   Imports the shared library named 'utils' for use in the pipeline -> Option C

4. Quick Check:

   @Library('name') imports shared library [OK]

Hint: @Library('name') imports shared library code [OK]

Common Mistakes:

• Thinking it defines a new library inside the pipeline
• Confusing it with plugin execution
• Assuming it sets the agent type

4. You configured a global shared library named 'commonLib' but your Jenkinsfile fails with an error: Library not found: commonLib. What is the most likely cause?

medium

A. The library name in Jenkinsfile does not match the configured global library name

B. The Jenkins agent is offline

C. The Jenkinsfile syntax is incorrect

D. The Jenkins user does not have permission to run the job

Solution

1. Step 1: Analyze the error message

   The error 'Library not found' means Jenkins cannot find a shared library with the given name.

2. Step 2: Check library name consistency

   The most common cause is a mismatch between the library name used in the Jenkinsfile and the name configured globally.

3. Final Answer:

   The library name in Jenkinsfile does not match the configured global library name -> Option A

4. Quick Check:

   Library name mismatch = library not found [OK]

Hint: Check library name spelling matches exactly [OK]

Common Mistakes:

• Assuming agent offline causes library not found
• Blaming Jenkinsfile syntax errors
• Thinking user permissions cause this error

5. You want to configure a global shared library in Jenkins that is stored in a Git repository. Which two settings must you provide in the global shared library configuration to make it work? Select the best pair.

hard

A. Name of the library and Git repository URL

B. Library name and Jenkins agent label

C. Git repository URL and Jenkins user credentials

D. Library name and build trigger schedule

Solution

1. Step 1: Identify required settings for global shared library

   To configure a global shared library from Git, you must provide the library name and the Git repository URL where the code is stored.

2. Step 2: Confirm other options

   Agent labels, user credentials, or build triggers are not mandatory for the basic global library setup.

3. Final Answer:

   Name of the library and Git repository URL -> Option A

4. Quick Check:

   Library name + Git URL = required [OK]

Hint: Library name and Git URL are essential [OK]

Common Mistakes:

• Confusing agent label with library config
• Thinking credentials are always required here
• Mixing build triggers with library setup