https://github.com/jenkinsci/mqtt-notification-plugin

A Jenkins Notifier plugin using MQTT
https://github.com/jenkinsci/mqtt-notification-plugin

java jenkins-ci jenkins-plugin mqtt

Last synced: 3 months ago
JSON representation

A Jenkins Notifier plugin using MQTT

• Host: GitHub
• URL: https://github.com/jenkinsci/mqtt-notification-plugin
• Owner: jenkinsci
• License: mit
• Fork: true (gdubya/mqtt-notification-plugin)
• Created: 2013-04-02T09:48:36.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-05-17T03:02:04.000Z (over 1 year ago)
• Last Synced: 2024-09-25T15:29:46.194Z (3 months ago)
• Topics: java, jenkins-ci, jenkins-plugin, mqtt
• Language: Java
• Homepage: https://plugins.jenkins.io/mqtt-notification-plugin/
• Size: 78.1 KB
• Stars: 6
• Watchers: 101
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
MQTT Notification plugin

====================

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/mqtt-notification-plugin.svg)](https://plugins.jenkins.io/mqtt-notification-plugin)

[![GitHub release](https://img.shields.io/github/release/jenkinsci/mqtt-notification-plugin.svg?label=changelog)](https://github.com/jenkinsci/mqtt-notification-plugin/releases/latest)

[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/mqtt-notification-plugin.svg?color=blue)](https://plugins.jenkins.io/mqtt-notification-plugin)

# About

A simple notifier that can publish build notifications to a topic on

a [MQTT](http://mqtt.org/) broker.

[MQTT](http://mqtt.org/) is a machine-to-machine (M2M)/"Internet of

Things" connectivity protocol. It was designed as an extremely

lightweight publish/subscribe messaging transport.

# Configuration

The following details are configurable per Jenkins job:

-   Broker hostname/port

-   Topic

-   Message

Both the topic and the message may also include certain dynamic

variables. These include:

-   PROJECT\_URL - The relative URL to the Jenkins project to which this

    job belongs (e.g. "job/my-build").

-   BUILD\_RESULT - The result of the Job (e.g. SUCCESS, FAILURE,

    ABORTED, etc.)

-   BUILD\_NUMBER - The build number

-   CULPRITS - Comma-separated list of build culprits

All other build variables and environment variables can also be

used ([JENKINS-41839](https://issues.jenkins-ci.org/browse/JENKINS-41839)).

The default topic when no value is specified is "jenkins/PROJECT\_URL".

The default message when no value is specified is "BUILD\_RESULT".

# License

This Jenkins plugin is licensed under the [MIT License](./LICENSE.txt).