How to use Jenkins Pipeline Folder-Level Shared Library?

Question

We have few components which is stored in their own git repositories. Specific combination of those components are built and delivered as solutions for different type of deployments/customers. So, we have a pipeline git repository which has multiple Jenkinsfile (with different names - and so the build names).

Obviously, there are many things common between these pipelines. I'm aware of Jenkins shared library and it works when they're given their own git repository. But, since my pipelines are already in dedicated git repository, I'm curious to know how to use "Folder-level Shared Libraries" explained here --> https://jenkins.io/doc/book/pipeline/shared-libraries/#folder-level-shared-libraries

But, I'm not able to figure out how to use this Folder-level shared libraries. I couldn't find any examples/documentation for this style of libraries.

Any pointers to documentation/example - or guidelines on how to go with this will be greatly appreciated.

Thanks.

You know it's about jobs that are grouped inside a folder in Jenkins, not about loading the code from a sub-directory of the Git repo, don't you? — StephenKing, Aug 20 '17 at 20:23
No. I don't have my plans grouped under folders and so I didn't thought of such case. Thanks for the information. Now; is there any feature of Jenkins using which I can have my library in same repo as pipeline definitions? — R Kaja Mohideen, Aug 21 '17 at 08:08

Pawel Wiejacha · Answer 1 · 2017-12-19T22:00:34.170

I guess that proper way to do that is to implement a custom SCMRetriever and use library step.

However, you can use the following hack:

Assuming jenkins/vars/log.groovy in your local repo contains:

def info(message) {
    echo "INFO: ${message}"
}

Your Jenkinsfile can load that shared library from the jenkins/ directory using library step:

node('node1') { // load library
    checkout scm
    // create new git repo inside jenkins subdirectory
    sh('cd jenkins && git init && git add --all . && git commit -m init &> /dev/null') 
    def repoPath = sh(returnStdout: true, script: 'pwd').trim() + "/jenkins"
    library identifier: 'local-lib@master', retriever: modernSCM([$class: 'GitSCMSource', remote: repoPath])
}

node('node2') {
    stage('Build') {
        log.info("called shared lib") // use the loaded library
    }
}

dahaze · Answer 2 · 2022-05-23T06:06:15.183

First: To use the Folder-level shared library, you have to create the standard library structure and commit it to a SCM repository.

Second: You have to configure jenkins to use the library in the options dialog of the folder where your pipeline is located.

Simple example with scripted pipeline and no extra repository for the library:

"<URL>/my-test-repo.git"
    |
    |- <JenkinsPipelineScript>
    |
    |- "jenkins_lib"
        |
        |- resources
        |- src
        |- vars
            |- "HelloWorld.groovy"

So in your JenkinsPipelineScript just import the library by

@Library('jenkins_lib') _

and call the "HelloWord.groovy" by

HelloWorld()

The HelloWorld.groovy can look like this:

def call() {
sh "echo Hello world from library-script!" 
}

How to use Jenkins Pipeline Folder-Level Shared Library?

2 Answers2

Linked