Global shared library configuration in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Global Shared Library in Jenkins?

A Global Shared Library in Jenkins is a reusable set of scripts and code that can be used across multiple Jenkins pipelines to avoid duplication and promote consistency.

beginner

How do you configure a Global Shared Library in Jenkins?

You configure it in Jenkins by going to 'Manage Jenkins' > 'Configure System' > 'Global Pipeline Libraries' section, then adding the library details like name, default version, and source code repository.

intermediate

What is the purpose of the 'default version' in a Jenkins Global Shared Library?

The 'default version' specifies which branch, tag, or commit of the shared library repository Jenkins should use if no specific version is requested in the pipeline.

beginner

How do you load a Global Shared Library in a Jenkins pipeline script?

You use the '@Library' annotation followed by the library name, for example:

@Library('my-shared-lib') _

This imports the library for use in the pipeline.

beginner

What are the benefits of using Global Shared Libraries in Jenkins?

Benefits include code reuse, easier maintenance, consistent pipeline logic, and faster pipeline development by sharing common functions and steps.

Where do you configure a Global Shared Library in Jenkins?

A Manage Jenkins > System Log

B Manage Jenkins > Manage Plugins

C New Item > Pipeline

D Manage Jenkins > Configure System > Global Pipeline Libraries

Global Shared Libraries are configured under 'Manage Jenkins' > 'Configure System' > 'Global Pipeline Libraries'.

What does the '@Library' annotation do in a Jenkins pipeline?

A Specifies the Jenkins agent

B Imports a Global Shared Library into the pipeline

C Defines a new pipeline stage

D Triggers a build

The '@Library' annotation imports the specified Global Shared Library for use in the pipeline script.

What is the 'default version' in a Jenkins Global Shared Library configuration?

A The branch, tag, or commit used if no version is specified

B The Jenkins version required

C The default pipeline script

D The default build agent

The 'default version' tells Jenkins which version of the library to use if the pipeline does not specify one.

Why use Global Shared Libraries in Jenkins?

A To increase build time

B To disable pipeline scripts

C To reuse code and keep pipelines consistent

D To manage Jenkins plugins

Global Shared Libraries help reuse code and keep pipeline logic consistent across projects.

Which source control systems can be used for Jenkins Global Shared Libraries?

A Git, Subversion, Mercurial

B Only Git

C Only FTP servers

D Only local files

Jenkins supports multiple source control systems like Git, Subversion, and Mercurial for shared libraries.

Explain how to set up and use a Global Shared Library in Jenkins pipelines.

Think about configuration steps and how to import the library in pipeline code.

Describe the benefits of using Global Shared Libraries in Jenkins and how they improve pipeline management.

Consider how sharing code helps teams and projects.

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