@Library annotation in Jenkins - Mini Project: Build & Apply

Using the @Library Annotation in Jenkins Pipelines

📖 Scenario: You are working on a Jenkins pipeline project where you want to reuse shared code stored in a separate Git repository. Jenkins provides a way to include shared libraries using the @Library annotation.This project will guide you step-by-step to create a simple Jenkins pipeline script that uses the @Library annotation to load a shared library and call a function from it.

🎯 Goal: Build a Jenkins pipeline script that uses the @Library annotation to load a shared library named my-shared-lib and calls a function sayHello() from that library.

📋 What You'll Learn

Create a Jenkins pipeline script with the @Library annotation

Declare the shared library name exactly as my-shared-lib

Call the sayHello() function from the shared library

Print the output of sayHello() in the pipeline

💡 Why This Matters

🌍 Real World

In real Jenkins projects, shared libraries help teams reuse common pipeline code, reducing duplication and errors.

💼 Career

Understanding how to use the @Library annotation is essential for Jenkins pipeline developers and DevOps engineers to write modular and maintainable pipelines.

1

Create a basic Jenkins pipeline script

Create a Jenkins pipeline script with a pipeline block and a stages section containing one stage named Example. Inside the stage, add a steps block with a placeholder comment.

Jenkins

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Start by writing the basic Jenkins pipeline structure with pipeline, agent any, and one stage named Example.

2

Add the @Library annotation to load the shared library

Add the @Library annotation at the top of the script to load the shared library named my-shared-lib. Use the syntax @Library('my-shared-lib') _ exactly.

Jenkins

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

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Place the @Library('my-shared-lib') _ annotation at the very top of the Jenkinsfile to load the shared library.

3

Call the sayHello() function from the shared library

Inside the steps block of the Example stage, add a script block. Inside the script block, call the function sayHello() and assign its result to a variable named message.

Jenkins

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

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                script {
                    // Your code here
                }
            }
        }
    }
}

Hint

Use a script block inside steps to write Groovy code. Call sayHello() and store the result in message.

4

Print the message returned by sayHello()

Still inside the script block, add a println statement to print the message variable.

Jenkins

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

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                script {
                    def message = sayHello()
                    // Your code here
                }
            }
        }
    }
}

Hint

Use println(message) to print the message returned by sayHello().

Practice

1. What is the main purpose of the @Library annotation in Jenkins pipelines?

easy

A. To specify the pipeline agent type

B. To load shared code libraries for reuse in pipelines

C. To define environment variables for the pipeline

D. To trigger downstream jobs automatically

Solution

1. Step 1: Understand the role of @Library

   The @Library annotation is used to load shared libraries in Jenkins pipelines.

2. Step 2: Identify its main purpose

   Loading shared libraries allows reuse of code and better organization of pipeline scripts.

3. Final Answer:

   To load shared code libraries for reuse in pipelines -> Option B

4. Quick Check:

   @Library loads shared libraries = C [OK]

Hint: Remember: @Library loads reusable code libraries [OK]

Common Mistakes:

• Confusing @Library with environment variable setup
• Thinking it triggers jobs instead of loading code
• Using it to specify pipeline agents

2. Which of the following is the correct syntax to load a shared library named 'utils' in a Jenkinsfile?

easy

A. @Library('utils') _

B. @Library utils _

C. library('utils') _

D. @LoadLibrary('utils') _

Solution

1. Step 1: Recall the correct syntax for @Library

   The correct syntax uses parentheses and quotes around the library name, followed by an underscore.

2. Step 2: Match the syntax to options

   @Library('utils') _ matches @Library('utils') _, which is correct.

3. Final Answer:

   @Library('utils') _ -> Option A

4. Quick Check:

   Correct syntax uses parentheses and underscore = A [OK]

Hint: Use parentheses and underscore after @Library [OK]

Common Mistakes:

• Omitting parentheses or quotes
• Using wrong annotation like @LoadLibrary
• Placing underscore before the annotation

3. Given this Jenkinsfile snippet:

@Library('mathLib') _
pipeline {
  agent any
  stages {
    stage('Calculate') {
      steps {
        script {
          echo mathLib.add(2, 3).toString()
        }
      }
    }
  }
}

What will be the output if the shared library 'mathLib' has a method add(a, b) that returns the sum of two numbers?

medium

A. 5

B. mathLib.add(2, 3)

C. Error: method not found

D. 23

Solution

1. Step 1: Understand the method call in the script block

   The code calls mathLib.add(2, 3) which returns the sum of 2 and 3.

2. Step 2: Convert the result to string and echo

   The result 5 is converted to string and printed by echo.

3. Final Answer:

   5 -> Option A

4. Quick Check:

   Sum of 2 and 3 = 5 [OK]

Hint: Method returns sum; echo prints '5' as string [OK]

Common Mistakes:

• Expecting the method name printed instead of result
• Confusing concatenation with addition
• Assuming method is missing causing error

4. You wrote this at the top of your Jenkinsfile:

@Library('commonLib')
pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        script {
          commonLib.doSomething()
        }
      }
    }
  }
}

But Jenkins throws an error saying Missing required underscore after @Library annotation. How do you fix it?

medium

A. Change @Library to @LoadLibrary

B. Remove the parentheses from @Library

C. Place the underscore before the annotation like _ @Library('commonLib')

D. Add an underscore _ immediately after the annotation like @Library('commonLib') _

Solution

1. Step 1: Identify the syntax error from the message

   The error says the underscore is missing after @Library, which is required syntax.

2. Step 2: Correct the syntax by adding underscore

   Add an underscore immediately after the annotation: @Library('commonLib') _.

3. Final Answer:

   Add an underscore _ immediately after the annotation like @Library('commonLib') _ -> Option D

4. Quick Check:

   Underscore after @Library fixes syntax [OK]

Hint: Always put underscore right after @Library(...) [OK]

Common Mistakes:

• Omitting the underscore
• Placing underscore before annotation
• Changing annotation name incorrectly

5. You want to load two shared libraries named 'utils' and 'helpers' in your Jenkinsfile. Which is the correct way to do this using the @Library annotation?

hard

A. @Library('utils_helpers') _

B. @Library('utils') _ @Library('helpers') _

C. @Library(['utils', 'helpers']) _

D. @Library('utils,helpers') _

Solution

1. Step 1: Recall how to load multiple libraries

   Multiple libraries can be loaded by passing a list of names inside @Library annotation.

2. Step 2: Identify correct syntax for multiple libraries

   The correct syntax is @Library(['utils', 'helpers']) _ which loads both libraries at once.

3. Final Answer:

   @Library(['utils', 'helpers']) _ -> Option C

4. Quick Check:

   Use list inside @Library for multiple libs [OK]

Hint: Use list syntax inside @Library to load many libs [OK]

Common Mistakes:

• Trying to use multiple @Library annotations
• Passing comma-separated string instead of list
• Combining names into one string without list