jenkins-library
The collection of reusable methods and pipelines for jenkins. It is based on jenkins-shared-library functionality.
Install
Dependencies
Different parts how some dependencies. For instance,
- font and logging method “collections” depend on jenkins-ansicolor-plugin
- ecrUtils depends on aws-cli and docker-cli, so this things needs to be installed on the jenkins agent(s) running the job.
Setup as a “Global Pipeline Library”
To install it as a global shared library, open Manage Jenkins » Configure System in jenkins web UI and find Global Pipeline Libraries block. You can add as many shared libraries as needed here, just press “Add” button and fill in required information:
- Name is a library name by which you can then import things inside your pipeline. Must be unique. For instance, the name could be “jenkins-library”
- Default version it may be a branch name, tag, commit hash
- For the Retrieval method just use “Modern SCM”, “Git” and use URL to this repository (https://github.com/MaksymDolgykh/jenkins-library.git) in the Project Repository field
Something like on the screenshot below
Basically, that is it. Now you can import things from the shared jenkins library inside your pipeline. For more details about setup please look into jenkins docs
Usage
There is usage example in this Jenkinsfile. In a nutshell you just need to import shared library with @Library annotation, like this
@Library('jenkins-library@master') _
Then you can refer to methods defined in the vars/, something like
ecrUtils.ecrLogin(["us-east-1"])
With the above example console output is going to look like
License
This project is licensed under the Apache License 2.0 (LICENSE)