Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mylyn/Bugzilla Connector"
(→Custom Transitions) |
|||
Line 111: | Line 111: | ||
name :NEW:, can_change_to :POST,CLOSED: | name :NEW:, can_change_to :POST,CLOSED: | ||
− | The first part of the file details some configuration details | + | The first part of the file details some configuration details |
+ | |||
+ | CustomStatusNames indicates whether custom statuses are used. Defaults to false if unspecified. | ||
+ | |||
+ | DuplicateStatus is the value of duplicate_or_move_bug_status in the Bugzilla Bug Change Policies. Defaults to RESOLVED if unspecified. | ||
+ | |||
+ | ClosedCustomStatus is a list of custom statuses which leave the bug in a closed state. Defaults to an empty list if unspecified. | ||
The <transitions> marker is used to indicate the beginning of the transitions list, and transitions should follow the format above for each status. | The <transitions> marker is used to indicate the beginning of the transitions list, and transitions should follow the format above for each status. | ||
− | There are plans to pull the majority of this information from the Bugzilla XMLRPC API in the future. | + | Additional tags will be added as needed to accurate describe a Bugzilla installation. There are plans to pull the majority of this information from the Bugzilla XMLRPC API in the future. |
=== Developer Resources === | === Developer Resources === | ||
[[Mylyn Offline Refactoring]] | [[Mylyn Offline Refactoring]] |
Revision as of 10:32, 25 June 2010
Contents
Bugzilla Server Optimization
- Tips for server administrators describes a solution taken by Eclipse.org webmasters to reduce the bandwidth requirements due to Mylyn clients updating their repository configuration.
GZIP encoding and content negotiation
The Mylyn Bugzilla Connector has been modified to accept gzip encoding on all requests, and will do content negotiation. See bug 205708.
Preventing excessive logfile fill up
- When running /bugzilla/ locally, one can prevent Mylyn filling up the log files by adding this to httpd.conf:
<DirectoryMatch /bugzilla/ >
BrowserMatchNoCase mylyn mylyn=1
</DirectoryMatch>
CustomLog "/private/var/log/httpd/access_log" combined env=!mylyn
Users
Langugage Configurations
Since Version 2.2 of Mylyn you can now add support for alternate languages via extension point:
org.eclipse.mylyn.bugzilla.core.languages
Here is an example definition for the English language (en (default)).
<extension point="org.eclipse.mylyn.bugzilla.core.languages"> <language name="en"> <languageAttribute command="error_login" response="Login"/> <languageAttribute command="error_login" response="log in"/> <languageAttribute command="error_login" response="check e-mail"/> <languageAttribute command="error_login" response="Invalid Username Or Password"/> <languageAttribute command="error_collision" response="Mid-air collision!"/> <languageAttribute command="error_comment_required" response="Comment Required"/> <languageAttribute command="error_logged_out" response="logged out"/> <languageAttribute command="bad_login" response="Login"/> <languageAttribute command="bad_login" response="log in"/> <languageAttribute command="bad_login" response="check e-mail"/> <languageAttribute command="bad_login" response="Invalid Username Or Password"/> <languageAttribute command="bad_login" response="error"/> <languageAttribute command="processed" response="processed"/> <languageAttribute command="changes_submitted" response="Changes submitted"/> <languageAttribute command="error_confirm_match" response="confirm match"/> </language> </extension>
Here is the detail description.
We have the following seven Commands defined in Mylyn:
Command | Class & Method | usage |
---|---|---|
error_login | BugzillaClient.parseHtmlError | detect login errrors |
error_collision | BugzillaClient.parseHtmlError | detect a midair collision |
error_comment_required | BugzillaClient.parseHtmlError | detect if a comment is required |
error_logged_out | BugzillaClient.parseHtmlError | detect if the user is logged out |
changes_submitted | BugzillaClient.parseHtmlError | changes are submitted (no real error) |
processed | BugzillaClient.postTaskData | process was successful |
bad_login | BugzillaTaskHistoryParser.retrieveHistory | detect bad login |
error_confirm_match | BugzillaClient.parseHtmlError | responce if usermatchmode is enabled |
For every Action there must be one or more responses.
Here is and example where the English responses for bugzilla-3.0.1 were found.
Text | File | Line |
---|---|---|
processed | template/en/default/bug/process/header.html.tmpl | 37 |
"Mid-air collision!" | template/en/default/bug/process/header.html.tmpl | 40 |
"Comment Required" | template/en/default/global/user-error.html.tmpl | 241 |
"Invalid Username Or Password" | template/en/default/global/user-error.html.tmpl | 822 |
'bug' => "Changes submitted for $link" | template/en/default/bug/process/results.html.tmpl | 45 |
Login | currently not known | |
log in | currently not known | |
check e-mail | currently not known | |
logged out | currently not known | |
"confirm match" | template/en/default/global/confirm-user-match.html.tmpl | 43 |
You must look for the tranlated responses in templates of the other language.
Custom Transitions
Custom Workflows have been enabled in Bugzilla since Bugzilla 3.2. As the first stage of efforts to make Mylyn detect these workflows, Mylyn has been given the ability to parse a transition descriptor file to pick up custom transitions and custom statuses.
Here is a simplified example:
CustomStatusNames=true DuplicateStatus=CLOSED ClosedCustomStatus=POST <transitions> name :UNCONFIRMED:, can_change_to :NEW,POST,CLOSED: name :NEW:, can_change_to :POST,CLOSED:
The first part of the file details some configuration details
CustomStatusNames indicates whether custom statuses are used. Defaults to false if unspecified.
DuplicateStatus is the value of duplicate_or_move_bug_status in the Bugzilla Bug Change Policies. Defaults to RESOLVED if unspecified.
ClosedCustomStatus is a list of custom statuses which leave the bug in a closed state. Defaults to an empty list if unspecified.
The <transitions> marker is used to indicate the beginning of the transitions list, and transitions should follow the format above for each status.
Additional tags will be added as needed to accurate describe a Bugzilla installation. There are plans to pull the majority of this information from the Bugzilla XMLRPC API in the future.