Jenkins DevOps Shared Libraries

A collection of Jenkins Pipeline shared libraries for common DevOps software. Usage and dependencies for each can be found in the documentation.

Unsure how to use these in your declarative syntax Jenkinsfile? Check the declarative Jenkinsfile shared library documentation.

Additionally, you can pare down the libraries available from this repo and then load those in yourself from your own git repo or otherwise.

Retrieve and use with Disabled Sandbox

Basically, if you have the GitHub Branch Source plugin installed, then you can load a specific version like:

@Library('github.com/mschuchard/jenkins-devops-libs@version')_

If you do not have this plugin installed, or want more flexibility over the version used, then you can use or expand upon this class:

library identifier: 'jenkins-devops-libs@master', retriever: modernSCM(
  [$class: 'GitSCMSource',
   remote: 'https://github.com/mschuchard/jenkins-devops-libs.git'])

Note that this latter example is also useful for circumventing Github API rate limit issues.

Use with Enabled Sandbox

Basically, you need to first add the shared library in the Jenkins global configuration. Then, you can either load the library's methods with:

@Library('jenkins-devops-libs@version')_

or using the defaults with:

library('jenkins-devops-libs')

Supported

• AWX/Ansible Tower (alpha)
• Goss
• Helm
• OpenFaaS
• Packer
• Puppet Enterprise (beta)
• Terraform

DSL Change

Starting with version 1.4.0 of the libraries, the new DSL will be supported. The new DSL appears like the following syntax:

// Map type argument
library.method(
  param_one: value,
  param_two: value
)

The documentation has also been updated to reflect the new DSL. The old DSL will be supported until version 2.0.0. The old DSL appears like the following syntax:

// Closure type argument
library.method {
  param_one = value
  param_two = value
}

It is recommended to update your usage at your earliest convenience, but both will be supported for versions >= 1.4.0 < 2.0.0.

Contributing

Code should pass all acceptance tests. New features should involve new acceptance tests.

Please consult the GitHub Project for the current development roadmap.