foneox / stashnotifier-plugin

A Jenkins Plugin to notify Atlassian Stash|Bitbucket of build results

Stash Build Notifier Plugin for Jenkins

This Jenkins plugin notifies Stash of build results. Failed or successful builds will show up as little icons in the Stash web interface in commit logs. Clicking on such an icon will take the user to the specific build.

Requirements

• Stash 2.1 or newer. This plugin uses the Atlassian Stash Build REST API which was introduced with Stash 2.1.
• Jenkins 1.498 or newer

Setup

Set up Stash Notifier by navigating to Manage Jenkins --> Configure System and scrolling down to the Stash Notifier section. Enter at least your Stash Root Url and Credentials. Additional options are available as required. (Screenshot below is from Jenkins v2.44)

Usage

Use the Stash Notifier by adding it as a Post Step in your Jenkins build job configuration.

1. In your Jenkins job configuration go to the Post-build Actions section, click on Add post-build action and select Notify Stash Instance
2. Enter the Stash base URL, e. g. http://localhost:7990 or http://my.company/stash. If in doubt, go to your local Stash server and check the URL in the browser. The URL http://georg@localhost:7991/projects e. g. reveals the server base URL, which is http://localhost:7991 in this case.
3. Use the Credentials Plugin to select credentials for stash

That's it. If you have configured everything correctly, Jenkins will notify your Stash instance of subsequent builds. The result is illustrated on Atlassians Stash Build Integration wiki page.

Note on Pipeline Plugin usage

See the following code for an example of how to use this plugin inside of a Pipeline Plugin. You must set the result of the current build manually in the Pipeline script.

node {
    checkout scm                            // Necessary so we know the current commit

    notifyBitbucket()                       // Notifies the Stash Instance of an INPROGRESS build

    try {
        // Do stuff

        currentBuild.result = 'SUCCESS'     // Set result of currentBuild !Important!
    } catch(err) {
        currentBuild.result = 'FAILED'      // Set result of currentBuild !Important!
    }

    notifyBitbucket()                       // Notifies the Stash Instance of the build result
}

In situations where an advanced setup is required the following can be used:

node {
    this.notifyBitbucket('INPROGRESS')     // Notifies the Stash Instance of an INPROGRESS build
    
    try {
        // Do stuff
    
        this.notifyBitbucket('SUCCESS')
    } catch(err) {
        this.notifyBitbucket('FAILED')
    }
}

def notifyBitbucket(String state) {

    if('SUCCESS' == state || 'FAILED' == state) {
        currentBuild.result = state         // Set result of currentBuild !Important!
    }
    notifyBitbucket commitSha1: "commit", 
                credentialsId: '00000000-1111-2222-3333-123456789abc', 
                disableInprogressNotification: false, 
                considerUnstableAsSuccess: true, 
                ignoreUnverifiedSSLPeer: true, 
                includeBuildNumberInKey: false, 
                prependParentProjectKey: false, 
                projectKey: '', 
                stashServerBaseUrl: 'https://stash.company.com'

}

In Declarative Pipelines, where Jenkins sets currentBuild.result = null for SUCCESS builds, the current value can be modified via a script step, e.g.:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Hello World'
                // currentBuild.result == null here
            }
        }
    }
    post { 
        always { 
            script {
                currentBuild.result = currentBuild.result ?: 'SUCCESS'
                notifyBitbucket()
            }
        }
    }
}

Note on credentials

Currently Stash Build Notifier Plugin accepts only raw plaintext credentials as it works over the HTTP REST API of stash.

Maintainers

• Georg Gruetter (Twitter, GitHub)
• Pavel Batanov (GitHub)

License

Apache 2.0 License