Clone wiki

scm-manager-plugins / Bugzilla

SCM Manager Bugzilla Plugin

The Bugzilla plugin

The SCM Manager Bugzilla Plugin enables the SCM-Manager to interact with the bug tracking system Bugzilla. This plugin analyzes each commit within a configured repository and requests Bugzilla to add a comment for a specific Bug if needed. The Bugzilla Plugin can also set bugs to be fixed if desired.

Have a look at the release notes for the last changes.

Installing the Bugzilla Plugin

For installing the Bugzilla Plugin, please visit the SCM-Manager web front end of your SCM-Manager instance. Click the Link “Plugins” which is shown in the left menu panel. The plugin menu will be opened and it will show you a variety of available plugins grouped by their specific scope of functions. If closed, open the group “Issue-Tracking”. Here you can find the plugin “scm-bugzilla-plugin”. Click “Install”, which can be found in the plugin’s row of the plugin listing. After this, the SCM-Manager installs the plugin automatically. Please restart the SCM-Manager web application after the installation process finished.

Configuring the Bugzilla Plugin

After installing the Bugzilla Plugin and restarting the SCM-Manager web application, new configuration options will be available. Click the Link “General” in the “Config”-Group of the left menu panel to access the global configuration form or select a repository in the repository overview and open the “Bugzilla”-tab to access the configuration form for a specific repository.

Bugzilla Plugin config

In these configuration forms you will see some input fields which are used as follows.

Url

This URL specifies the location of the Bugzilla instance which will receive messages after a commit was done. Enter the context path of the Bugzilla instance here (e.g. http://localhost:80/bugzilla/).

Bug number prefix

For figuring out which bug in Bugzilla is meant to be commented when sending the commit message, the Bugzilla Plugin needs a token to recognize the bug’s number. Whenever a commit message is received by the SCM-Manager, the message will be analyzed for this token followed by a number. If these two parts are found, the number will be extracted and it will be used as bug number to specify the bug which was meant to be commented by the developer.

For example the bug number prefix is “Bug #”. When a commit message, containing the substring “Bug #1337”, is received by the SCM-Manager, the bug number 1337 can be extracted.

Update Bugzilla Issues

Enable this option to tell the Bugzilla Plugin to add comments to the specific Bugs. Disable this option to disable the Bugzilla Plugin for the specific repository. Enable Auto-Close and Auto-Close-Words Enabling the auto-close-option will allow the Bugzilla Plugin to set a bug’s state to “fixed” if one or more words of the commit message indicate a bugfix. The words which are recognized for a bugfix are listed in the input field “Auto-Close-Words”. These words are a comma separated values representing all tokens which can indicate a bugfix.

Username and Password (optional)

If you want to use a technical user in Bugzilla which can be used by the SCM-Manager to add its comments, enter this user’s credentials in these input fields. If you leave this fields blank the credentials of the committing user will be used.

Do not allow repository configuration (global configuration only)

Set this option to true for disabling the configuration of single repositories and to force the usage of the global configurations for each repository.

Use Login instead E-mail

If this box is unchecked the plugin uses the email of a user for Bugzilla authentication. Check the box if you want to use the login name of osers for authentication. Depending on your Bugzilla installation it could be that only one of the options can be used.

Updated