https://github.com/jcgay/jenkins-pushbullet-plugin

Report Jenkins build status with Pushbullet
https://github.com/jcgay/jenkins-pushbullet-plugin

jenkins pushbullet

Last synced: 5 days ago
JSON representation

Report Jenkins build status with Pushbullet

• Host: GitHub
• URL: https://github.com/jcgay/jenkins-pushbullet-plugin
• Owner: jcgay
• License: mit
• Created: 2017-02-05T15:21:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-02T04:28:23.000Z (over 3 years ago)
• Last Synced: 2023-03-22T11:49:16.978Z (over 1 year ago)
• Topics: jenkins, pushbullet
• Language: Java
• Homepage:
• Size: 103 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jenkins Pushbullet Plugin

A Jenkins plugin to report build status with [Pushbullet](https://www.pushbullet.com).

## Installation

Download [pushbullet.hpi](https://bintray.com/jcgay/maven/download_file?file_path=fr%2Fjcgay%2Fjenkins%2Fplugins%2Fpushbullet%2F0.4.1%2Fpushbullet-0.4.1.hpi) and install it manually in Jenkins (`http://jenkins/pluginManager/advanced`).

## Usage

### Set admin Pushbullet access token

To send notifications, Jenkins needs a Pushbullet access token accessible from [here](https://www.pushbullet.com/account).  

Set it in `Pushbullet` section in Jenkins administration (`http:///configure`)

![Jenkins Configuration](https://jeanchristophegay.com/images/jenkins-pushbullet-plugin-admin-configuration.png)

If the token is not set, Jenkins will not try to send push notifications.

### User account

To receive notification each user must define its Pushbullet account ID (email) in Jenkins user settings (`http:///me/configure`).

![User Configuration](https://jeanchristophegay.com/images/jenkins-pushbullet-plugin-user2-configuration.png)

### Notified users

By default a push notification will be send to each user present in the build culprits list (as documented [here](http://javadoc.jenkins.io/hudson/model/AbstractBuild.html#getCulprits())).  

Also if a user has launched a build manually, he will receive a notification.  

Eventually users can be added in the job configuration `Report build status with Pushbullet`, these ones will be notified for every build. `Users` is a string of comma separated Jenkins user IDs (`toto,tata,titi` for example).

### Activate Pushbullet notification for a job

#### Freestyle Job

Add `Report build status with Pusbullet` as a `Post Build Action` in your Jenkins job:

![Job Configuration](https://jeanchristophegay.com/images/jenkins-pushbullet-plugin-job-configuration.png)

#### Pipeline script

To report a build state in a pipeline script, you'll need to handle errors.  

Basically you'll need to wrap your build sript in a `try/catch` (see [Documentation](https://github.com/jenkinsci/workflow-basic-steps-plugin/blob/master/CORE-STEPS.md#plain-catch-blocks))

```

node {

    try {

        sh 'might fail'

        pushbullet users:''

    } catch (e) {

        pushbullet users:''

        throw e

    }

}

```

#### Declarative pipeline

With declarative pipeline there is a post action that will be called before exiting the build.

```

pipeline {

    agent any

    stages {

        stage("Build") {

            steps {

                sh 'might fail'

            }

        }

    }

    post {

        always {

            pushbullet users: ''

        }

    }

}

```

# Build

Build the plugin locally with Maven:

    > mvn package

The plugin binary will be available in `target/pushbullet.hpi`.

## Status

[![Build Status](https://travis-ci.org/jcgay/jenkins-pushbullet-plugin.png)](https://travis-ci.org/jcgay/jenkins-pushbullet-plugin)

## Release

    mvn -B release:prepare release:perform