Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.97 KB

README.md

File metadata and controls

56 lines (44 loc) · 2.97 KB

SonarQube Redmine Plugin

Download and Version information: http://update.sonarsource.org/plugins/redmine-confluence.html

Build Status

Build Status

Description / Features

Description / Features This plugin connects SonarQube to Redmine (http://www.redmine.org) issue and project management tool in various ways.

Widget "Redmine Issues"

SonarQube retrieves the number of open issues associated to a project from Redmine. It then reports on the total number of issues and distribution by priority.

Widget "Redmine Developers"

SonarQube retrieves the number of open issues associated to a project from Redmine. It then reports on the total number of issues and distribution by developers.

Link a SonarQube review to a Redmine Issue

This feature allows you to create a review (on a violation) that will generate a Redmine Issue on your configured Redmine Installation When logged in, you should find the "Link to Redmine" action available on any violation: You can enter any comment and after you press "Link to Redmine", a new review comment is added on the violation: you can see the link to the newly-created Redmine issue.

Requirements

The plugins is only integrated with Redmine v2.2 or later.

Installation

Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory Restart the SonarQube server

Usage

Before you configure the plugin you need to get Redmine's API Access key Log in to your Redmine installation with administration rights Navigate to Administration > Settings > Authentication Enable Rest Web Service API Go to the "My Account" page ( /my/account ) and create a new API Access key on the right panel of your screen. Copy the API Access key to use it in plugin configuration

Plugin Configuration

At Global level, go to Settings -> Redmine and set Redmine's URL and API Access key you copied from previous step At Project level, go to Configuration -> Redmine Configuration Page Set the general settings for accessing Redmine : URL and the API Key you copied from previous step. Set the project key and click on the <Test the settings; gets priorities and trackers> button Pick up a default priority and default tracker for the redmine issues and save your settings

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.