How to Call Functions from Another File in Jenkins Pipeline

Learn how to effectively manage and use common functions in Jenkins Pipelines by calling functions from separate files.
---
This video is based on the question https://stackoverflow.com/q/67141045/ asked by the user 'lleviy' ( https://stackoverflow.com/u/12278308/ ) and on the answer https://stackoverflow.com/a/67141239/ provided by the user 'Dashrath Mundkar' ( https://stackoverflow.com/u/8053714/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How can I call function from another file in Jenkins pipeline?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Call Functions from Another File in Jenkins Pipeline

In the world of continuous integration and delivery, Jenkins has become a staple tool for automation. As projects grow larger and more complex, organizing your Jenkins pipelines effectively becomes crucial. One of the common challenges developers face is the need to call functions defined in separate files. If you've found yourself asking, "How can I call a function from another file in Jenkins pipeline?" you're in the right place!

Understanding the Problem

You may have created a structured directory for your Jenkins pipeline that includes a main Jenkinsfile and a separate file containing common functions. In this case, we have:

[[See Video to Reveal this Text or Code Snippet]]

The commonFunctions.groovy file contains a function buildDocker(def par, def par2) that you want to call from your pipeline.jenkinsfile. If attempting to call the function directly results in a MethodNotFound error, don't worry! There's a straightforward solution to this problem.

The Solution: Loading Functions in Your Pipeline

To successfully call a function from another file in a Jenkins pipeline, you need to follow these simple steps:

Step 1: Load the File

Instead of trying to call the function directly, you first need to load the commonFunctions.groovy file. You can achieve this by using the load command in your Jenkins pipeline script. Here's how to do it:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Ensure the Correct Return Statement

Make sure that your commonFunctions.groovy file has the return this statement at the end of the script. This ensures that the functions defined in that file can be accessed after loading it. Your commonFunctions.groovy should look like this:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Implement in Your Pipeline

Here’s how you can integrate it into your pipeline.jenkinsfile using the example stages you provided:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

By following the steps outlined above, you should now be able to call functions from another file in your Jenkins pipeline with ease. This approach not only promotes better code organization but also enhances reusability across multiple pipelines, making your automation processes more efficient.

Whether you're a seasoned Jenkins user or just starting, implementing these best practices will help streamline your CI/CD workflow. Happy coding!