# rabbitmq-publisher-plugin

**Repository Path**: mamh-java/rabbitmq-publisher-plugin

## Basic Information

- **Project Name**: rabbitmq-publisher-plugin
- **Description**: https://github.com/mamh-java/rabbitmq-publisher-plugin
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-14
- **Last Updated**: 2023-04-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Rabbit-MQ Publisher Plugin

[![Build Status](https://ci.jenkins.io/job/Plugins/job/rabbitmq-publisher-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/rabbitmq-publisher-plugin/job/master/)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/rabbitmq-publisher)](https://plugins.jenkins.io/rabbitmq-publisher)
[![Changelog](https://img.shields.io/github/v/tag/jenkinsci/rabbitmq-publisher-plugin?label=changelog)](https://github.com/jenkinsci/rabbitmq-publisher-plugin/blob/master/CHANGELOG.md)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/rabbitmq-publisher?color=blue)](https://plugins.jenkins.io/rabbitmq-publisher)
[![GitHub contributors](https://img.shields.io/github/contributors/jenkinsci/rabbitmq-publisher-plugin?color=blue)](https://github.com/jenkinsci/rabbitmq-publisher-plugin/graphs/contributors)

Plugin for Jenkins, allowing to publish message on a Rabbit MQ.

Older versions of this plugin may not be safe to use. Please review the
following warnings before using an older version:

-   [Credentials stored in plain
    text](https://jenkins.io/security/advisory/2019-03-06/#SECURITY-848)
-   [Server-side request
    forgery](https://jenkins.io/security/advisory/2019-03-06/#SECURITY-970)

## Description

This plugin allows to create a build step which can publish a message to Rabbit MQ

2 parts:

-   Configuration of the Rabbit Host
-   Configuration of the step

The message can be a raw json, or a simple string,  or a list a
key/value which can be converted to a json string.

## Usage

### System configuration

Add your connection configurations with the parameters:

-   name: label to select the desired configuration on the build step
-   host: the default host to use for connections
-   port: the default port to use for connections
-   username: the AMQP user name to use when connecting to the broker
-   password: the password to use when connecting to the broker

Example: 

![](docs/images/system-config.png)

### Job configuration

1.  Select the *Publish to Rabbit-MQ* step:  

    ![](docs/images/job-build.png)
    ![](docs/images/job-conntection.png)
2.  Add your configuration to publish your message   

    ![](docs/images/system-config.png) 
      
    You can use build parameters (eg: `${FOO}` or `$FOO`) which will be
    resolved before sending the message. You can also use
    `${BUILD\_USER\_ID}` and `${BUILD\_USER\_NAME}` to retrieve the
    informations from the user who launches the job.