Pipeline Shared Libraries Introduction

Pipeline Shared Libraries allow you to encapsulate common code into a shared library that can be reused across multiple Jenkins pipelines. This promotes code reuse and reduces duplication, making your Jenkinsfiles cleaner and more manageable.

• Shared Libraries: A mechanism to share Groovy scripts and resources.
• Global Libraries: Libraries available to all Jenkins jobs.
• Versioning: Libraries can be versioned using Git branches or tags.

3.1 Creating a Shared Library

To create a shared library, follow these steps:

1. Create a new Git repository for the shared library.
2. Organize the library structure:
Library Structure:

your-library/
  ├── vars/
  │   └── myFunction.groovy
  └── src/
      └── com/
          └── example/
              └── MyClass.groovy
                    

3. Configure Jenkins to recognize the shared library by adding it under Manage Jenkins > Configure System in the Global Pipeline Libraries section.

4.1 Using a Shared Library in a Jenkinsfile

To use the shared library in your pipeline, include it at the top of your Jenkinsfile:

@Library('your-library') _

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                script {
                    myFunction() // Call the shared library method
                }
            }
        }
    }
}

• Keep your library functions small and focused.
• Document your library functions clearly.
• Version your library and use semantic versioning.
• Avoid using global variables in shared libraries.
• Test your shared libraries thoroughly.