jenkins-flowdock-notifier

A simple Groovy script which enables Flowdock notifications to be sent from a Jenkins Pipeline. The current Flowdock notification plugin does not have any Pipeline integration--here is a stopgap.

Inspired by and lifted from this thread and this comment specifically.

Prerequisites

The following must be available in your Jenkins installation to use this library:

• Pipeline plugins, of course
• Pipeline: Shared Groovy Libraries plugin
• An appropriate source code management plugin supported by the above, probably the GitHub Branch Source plugin

Installation

A Jenkins administrator must install the library as follows:

1. In Manage Jenkins => Configure System, find the Global Pipeline Libraries section.
2. Click on Add.
3. Specify:

• Name: flowdock-notifier
• Default version: master

4. For retrieval method, assuming GitHub, select Modern SCM and then GitHub:

• Owner: c3tp
• Repository: jenkins-flowdock-notifier

5. Click Save at the bottom.

Use

You must declare use of the library somewhere before use:

library 'flowdock-notifier'

Then, call flowdockNotify in an appropriate place in your pipeline. It needs to be a step-class block, including and probably most appropriately a post block. There are three arguments:

1. this - passes the script object to the notifier function to provide necessary context
2. API token for Flowdock. This can be retrieved from your Flowdock profile page
3. A string containing list of tags (optional).

For example:

library 'flowdock-notifier'

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                echo 'Hello World'
                sh '/bin/false'
            }
        }
    }
    post { 
        changed { 
            flowdockNotify this,'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', '#test'
        }
    }
}