hkeeler / jenkins-shared-libraries

CFPB Jenkins Pipeline Shared Libraries

This is a collection of shared libraries to be used with Jenkins Pipelines

• Technology stack: Written in groovy/Jenkins Pipeline DSL. Requires Jenkins
• Status: This repo is intended to be an ongoing effort to collect useful Pipeline libraries.

Dependencies

This project is dependent on Jenkins Pipeline and Jenkins >= 2.46.3, though some earlier versions may work, they have not been tested.

Installation

These shared libraries may be accessed one of three ways:

1. Add this repo to 'Global Pipeline Libraries' in the Jenkins UI.
2. Include a libraries block in declarative pipeline syntax.
3. Include this library in an @Library statement in a Pipeline script.

Global Pipeline Libraries

See this article about adding shared libraries via the Jenkins UI.

Within Pipeline Script

The declarative way to include libraries is the following.

libraries {
    lib('github.com/cfpb/jenkins-shared-libraries')
}

Since this repo is hosted on github.com, it's easy to include it in all script dynamically by adding it to the @Library block within a Pipeline script

@Library('github.com/cfpb/jenkins-pipeline-shared-libraries') _

Usage

Currently this repo has a sendEmail var that can be invoked after importing it. Once the entire shared library has been imported, sendEmail is available at the top level. E.g.

pipeline {
    agent { label "master" }

    libraries {
        lib('github.com/cfpb/jenkins-shared-libraries')
    }

    stages {
        stage("Echostage") {
            steps {
               echo "foo"
            }
        }
    }
    post {
        always {
            script {
                sendEmail(currentBuild, ['[email protected]'])
            }
        }
    }
}"""

TODO

Maybe because we no longer have the triggers, 'fixed' emails no longer have 'Fixed' in the subject line, but instead say 'Building'. It would be nice if we could figure out why this is, and then get the 'Fixed' label back in the subject line. Note however that emails about failing builds do still say 'Failure' and 'Still Failing' in the subject.

Getting help

If you have any trouble working with this repo, please open a github issue.

Getting involved

Adding libraries to this repo is welcome and encouraged. Should you have an idea for a useful library or an improvement for an existing one fork this repo and open a PR.

General instructions on contributing can be found in CONTRIBUTING.

---

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

---

Credits and references

1. Jenkins Pipeline
2. Jenkins Automation
3. The wonderful Fabric8 repo