Library versioning in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is library versioning in Jenkins pipelines?

Library versioning in Jenkins pipelines means specifying which version of a shared library your pipeline should use. This helps keep your builds stable and predictable.

beginner

How do you specify a library version in a Jenkinsfile?

You specify a library version in a Jenkinsfile using the @Library annotation with the version name, like:
@Library('my-shared-lib@1.2.3') _

intermediate

Why is it important to use specific library versions instead of 'latest' in Jenkins?

Using specific versions avoids unexpected changes in your pipeline behavior. 'Latest' can change anytime, causing builds to break or behave differently.

intermediate

What happens if you don't specify a version for a shared library in Jenkins?

If no version is specified, Jenkins uses the default branch of the library, often 'master' or 'main'. This can lead to unpredictable pipeline results if the library changes.

advanced

How can you manage multiple versions of a shared library in Jenkins?

You can tag or branch your shared library repository for each version. Then, in Jenkinsfile, use the tag or branch name in the @Library annotation to pick the version you want.

How do you specify a version of a shared library in a Jenkinsfile?

A useLibrary('lib-name', 'version')

B library('lib-name', 'version')

C @Library('lib-name@version') _

D import library version

The correct syntax is @Library('lib-name@version') _ to specify the library and its version.

What is the risk of using the 'latest' version of a shared library in Jenkins?

A Builds will always be faster

B Builds may break due to unexpected changes

C It locks the pipeline to an old version

D It disables pipeline caching

Using 'latest' can cause builds to break because the library code might change without notice.

If no version is specified for a shared library, Jenkins uses:

A The last successful build version

B The oldest tagged version

C An error is thrown

D The default branch of the library repository

Jenkins defaults to the library's default branch, usually 'master' or 'main'.

How can you create different versions of a shared library?

A By tagging or branching the library repository

B By renaming the library folder

C By changing Jenkins global settings

D By using different Jenkins agents

Tagging or branching in version control creates distinct versions to use in Jenkins.

What does the underscore (_) mean after the @Library annotation?

A It loads the library into the pipeline script

B It comments out the annotation

C It specifies the library path

D It defines a variable

The underscore tells Jenkins to load the library into the pipeline script context.

Explain how to use library versioning in a Jenkins pipeline and why it is important.

Think about how you tell Jenkins which library code to use.

Describe the consequences of not specifying a library version in Jenkins pipelines.

Consider what happens when you don't lock the library code.

Practice

1. What does specifying a library version with @version in Jenkins pipelines help achieve?

easy

A. It disables the use of shared libraries in the pipeline.

B. It automatically updates the library to the latest version every time.

C. It ensures the pipeline uses a specific stable version of the shared library.

D. It deletes the library after the pipeline finishes.

Solution

1. Step 1: Understand library versioning purpose

   Library versioning lets you pick a specific version of shared code to keep builds stable.

2. Step 2: Analyze the effect of specifying @version

   Using @version locks the pipeline to that library version, avoiding unexpected changes.

3. Final Answer:

   It ensures the pipeline uses a specific stable version of the shared library. -> Option C

4. Quick Check:

   Library versioning = stable builds [OK]

Hint: Use '@version' to lock library version for stability [OK]

Common Mistakes:

• Thinking '@version' updates to latest automatically
• Believing it disables libraries
• Assuming it deletes libraries after use

2. Which of the following is the correct syntax to load a shared library named utils at version v2.1 in a Jenkins pipeline?

easy

A. library('utils@v2.1')

B. library('utils:v2.1')

C. library('utils#v2.1')

D. library('utils-v2.1')

Solution

1. Step 1: Recall Jenkins library version syntax

   Jenkins uses @ to specify the version or branch of a shared library.

2. Step 2: Match syntax to options

   Only library('utils@v2.1') uses the correct @ symbol for versioning.

3. Final Answer:

   library('utils@v2.1') -> Option A

4. Quick Check:

   Version syntax uses '@' [OK]

Hint: Use '@' to specify library version in library() call [OK]

Common Mistakes:

• Using ':' or '#' instead of '@' for version
• Combining name and version with '-'
• Omitting quotes around library name

3. Given this Jenkins pipeline snippet:

library('commonLib@release-1.0')
node {
  echo commonLib.hello()
}

What will happen if commonLib has a method hello() that returns "Hello v1.0"?

medium

A. The pipeline prints "Hello v1.0".

B. The pipeline prints "Hello latest".

C. The pipeline fails with a method not found error.

D. The pipeline ignores the library and prints nothing.

Solution

1. Step 1: Identify library version used

   The pipeline loads commonLib at version release-1.0.

2. Step 2: Understand method call effect

   Calling commonLib.hello() runs the method from version release-1.0, which returns "Hello v1.0".

3. Final Answer:

   The pipeline prints "Hello v1.0". -> Option A

4. Quick Check:

   Versioned library method returns expected output [OK]

Hint: Versioned library methods return outputs from that version [OK]

Common Mistakes:

• Assuming it prints latest version output
• Expecting a failure without checking version
• Thinking library is ignored without error

4. You wrote this line in your Jenkinsfile:

library('sharedLib@v1.2.3')

But the pipeline fails with an error: Library not found: sharedLib@v1.2.3. What is the most likely cause?

medium

A. The library name sharedLib is misspelled in the Jenkinsfile.

B. The version tag v1.2.3 does not exist in the library repository.

C. The Jenkins server is offline and cannot load any libraries.

D. The pipeline syntax requires double quotes instead of single quotes.

Solution

1. Step 1: Analyze error message

   The error says the library with version v1.2.3 was not found.

2. Step 2: Identify common causes

   This usually means the version tag v1.2.3 does not exist in the library's source repository.

3. Final Answer:

   The version tag v1.2.3 does not exist in the library repository. -> Option B

4. Quick Check:

   Missing version tag causes library not found error [OK]

Hint: Check if version tag exists in library repo when loading fails [OK]

Common Mistakes:

• Assuming syntax quotes cause the error
• Blaming library name spelling without checking version
• Ignoring network or server issues without evidence

5. You want to update your Jenkins pipeline to use a new library version feature-x but keep the old version stable available for some jobs. How can you manage this using Jenkins library versioning?

hard

A. Delete the stable version from the repository to force use of feature-x.

B. Rename the library folder for each version and update the pipeline accordingly.

C. Use library('lib') without version to automatically switch between versions.

D. Specify library('lib@feature-x') in new jobs and library('lib@stable') in old jobs.

Solution

1. Step 1: Understand versioning usage

   Jenkins library versioning lets you specify which version to use per pipeline.

2. Step 2: Apply versioning to different jobs

   By specifying @feature-x or @stable, you control which version each job uses independently.

3. Final Answer:

   Specify library('lib@feature-x') in new jobs and library('lib@stable') in old jobs. -> Option D

4. Quick Check:

   Use '@version' per job to manage multiple library versions [OK]

Hint: Use '@version' per job to switch library versions easily [OK]

Common Mistakes:

• Renaming folders instead of using version tags
• Omitting version to auto-switch versions
• Deleting stable version causing build failures