Skip to content
SonarQube plugin for sending notifications to Slack
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
documentation/screenshots
src
.editorconfig
.gitattributes
.gitignore
.travis.yml
Licence.md
README.md
analyze.sh
pom.xml
slack_info

README.md

CKS Sonar Slack Notifier Plugin

SonarQube plugin for sending notifications to Slack

This plugin sends a Slack message of project analysis outcome to congired project specific slack channel. The plugin uses Incoming Web Hook as the integration mechanism with Slack.

Install

The plugin must be placed in SONAR_HOME/extensions/plugins directory and SonarQube must be restarted.

Using latest release

You can find the latest release from https://github.com/kogitant/sonar-slack-notifier-plugin/releases/ page. Download the

From sources

To build the plugin simply run

mvn clean package

Configuration

After the plugin has been installed, you need to configure it. Although SonarQube offers project level configurations for some plugins, they cannot be used with this plugin because it runs in the "server side", and only sees the global settings.

As administrator, go to the general settings and configure the Sonar instance URL:

A new category Slack appears in the left menu:

Under it you can find the CKS Slack Notifier plugin configurations:

In the above example there is a Project Key to Slack Channel configuration for an example project. The project key of any SonarQube project can be found in the project page (bottom right corner):

Wildcard support

The project key supports wildcards at the end. See https://github.com/kogitant/sonar-slack-notifier-plugin/issues/2

Only send notification when Quality Gate fails

Notifications can be sent for all Quality Gate statuses, or just for WARNING/ERROR statuses. See https://github.com/kogitant/sonar-slack-notifier-plugin/issues/1

Example messages posted to Slack

New bug introduced

All good

Works with

  • Tested with SonarQube 6.1 against Slack on 2016.10.17
  • Tested with SonarQube 6.1 against Mattermost 3.5.0 on 2017.01.02

Inspired by

Benefits from

SonarQube Plugin Development guides

Slack webhook integration and message formatting guides

Analyzing this project with unit test and integration test coverage

    mvn clean jacoco:prepare-agent install -DskipITs=true
    mvn jacoco:prepare-agent-integration failsafe:integration-test
    mvn sonar-maven-plugin:sonar -Dsonar.host.url=http://localhost:9000
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.