Global shared library configuration in Jenkins - Commands & Configuration

Introduction

When you have multiple Jenkins pipelines that share common code, you can put that code in a global shared library. This helps you avoid repeating the same code in many places and makes updates easier.

When you want to reuse pipeline steps across different Jenkins jobs without copying code.

When you need to update a common function and want all pipelines to use the new version automatically.

When you want to organize your pipeline code better by separating reusable parts.

When you want to share helper scripts or utilities between multiple Jenkinsfiles.

When you want to keep your Jenkinsfiles simple by moving complex logic to a shared library.

Config File - config.xml

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<com.cloudbees.plugins.credentials.SystemCredentialsProvider>
  <domainCredentialsMap class="linked-hash-map">
    <entry>
      <com.cloudbees.plugins.credentials.domains.Domain>
        <specifications/>
      </com.cloudbees.plugins.credentials.domains.Domain>
      <java.util.concurrent.CopyOnWriteArrayList/>
    </entry>
  </domainCredentialsMap>
</com.cloudbees.plugins.credentials.SystemCredentialsProvider>

This is a minimal example of Jenkins system configuration XML. However, global shared libraries are configured via Jenkins UI or Groovy scripts, not directly by editing config.xml. The actual shared library configuration is stored inside Jenkins system configuration and managed through the UI under Manage Jenkins > Configure System > Global Pipeline Libraries.

For automation, you can use a Groovy script to define global shared libraries in Jenkins startup scripts or via the Jenkins script console.

Commands

This command uses Jenkins CLI to run a Groovy script that configures a global shared library in Jenkins. It automates adding the shared library without using the UI.

Terminal

jenkins-cli.jar -s http://localhost:8080 groovy = < globalSharedLibrary.groovy

Expected Output

Running script...

Library configured successfully

→

-s - Specifies the Jenkins server URL

Shows the Groovy script content that defines the global shared library configuration.

Terminal

cat globalSharedLibrary.groovy

Expected Output

import jenkins.model.*

import org.jenkinsci.plugins.workflow.libs.*



// Define the global shared library

LibraryConfiguration libConfig = new LibraryConfiguration('my-shared-lib')

libConfig.setDefaultVersion('main')

libConfig.setImplicit(true)

libConfig.setAllowVersionOverride(true)



// Set SCM source (Git)

GitSCMSource scmSource = new GitSCMSource('https://github.com/example/my-shared-lib.git')

libConfig.setSource(scmSource)



// Add the library to Jenkins global configuration

Jenkins.instance.getDescriptorByType(GlobalLibraries.class).setLibraries([libConfig])

Jenkins.instance.save()

Lists all configured global shared libraries in Jenkins to verify the new library is added.

Terminal

jenkins-cli.jar -s http://localhost:8080 list-libraries

Expected Output

my-shared-lib (default: main, implicit: true, allowVersionOverride: true)

→

-s - Specifies the Jenkins server URL

Key Concept

If you remember nothing else from this pattern, remember: global shared libraries let you write reusable pipeline code once and use it everywhere in Jenkins.

Common Mistakes

Trying to configure global shared libraries by editing Jenkins config.xml directly.

Jenkins stores global shared library settings internally and expects configuration via UI or Groovy scripts, not manual XML edits.

Use the Jenkins UI under Manage Jenkins > Configure System or automate with Groovy scripts via Jenkins CLI or startup scripts.

Not setting the library as implicit or default version, causing pipelines to fail to find the library.

If the library is not implicit or no default version is set, Jenkins pipelines must specify the library version explicitly, which can cause errors if omitted.

Set the library as implicit and provide a default version to simplify usage in pipelines.

Summary

Use Groovy scripts or Jenkins UI to configure global shared libraries for reusable pipeline code.

Run Jenkins CLI commands to apply and verify the shared library configuration.

Set default version and implicit usage to make the library easy to use in pipelines.

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