Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mylyn/UCOSP 2015 Project/documentation"
(Created page with " == Gerrit Workflow Modes == A new mode has been introduced to the Gerrit connector that introduces the concept of '''artifacts'''. This mode of setting artifacts is complete...") |
|||
Line 1: | Line 1: | ||
− | == Gerrit | + | == Gerrit Usage Modes == |
− | + | The Gerrit connector supports two usage modes: | |
− | + | * '''Using Gerrit With an Issue Tracker''': To reduce task list clutter and duplication, reviews with a task URL in the description are listed on their associated task instead of in the task list, and the task is decorated with the glasses icon when it has incoming reviews. | |
− | + | * '''Using Gerrit By Itself''': All reviews are treated as tasks: they are shown in the task list and can be activated and scheduled. | |
− | + | === Using Gerrit with an Issue Tracker === | |
− | + | When using Gerrit with an issue tracker such as Bugzilla, it is more natural to treat reviews as artifacts produced while working on a task, rather than as separate tasks with their own context, scheduled date, and due date. When the Issue Tracker usage mode is selected, reviews whose commit message contains the URL of another task in the task list are considered ''review artifacts''. | |
− | + | When this mode is selected, review artifacts will be shown in the task editor of the associated task instead of the task list. This way you can easily see all the reviews for the task including their incoming state. Filtering review artifacts from the task list significantly reduces clutter and incoming review noise. Review artifacts cannot be scheduled or activated; instead, schedule or activate the associated task. | |
− | + | [[File:task_editor_reviews_section.png]] | |
− | + | Note that you will still be able search for review artifacts using the text filter in the task list. | |
− | + | ===== Incoming Reviews ===== | |
− | + | ||
− | + | When a task has incoming reviews, the glasses icon will be shown next to the task in the task list: | |
− | + | [[File:Review_incoming.png]] | |
− | + | Open the task to see which reviews have incoming changes. | |
− | + | === Selecting a Usage Mode === | |
− | + | The usage mode can be configured on the repository settings page as shown here: | |
− | + | ||
− | + | ||
− | + | [[File:New_Gerrit_workflows.png]] | |
− | + | When enabling the Issue Tracker mode, existing reviews in your task list will be converted to review artifacts the next time they are synchronized. Only reviews whose commit message contains the URL of a task in the task list will be converted; additionally, reviews with a context, scheduled date, or due date will not be converted. You can switch back to the "By Itself" mode at any time; this will cause all review artifacts to become tasks again. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 02:18, 9 March 2016
Contents
Gerrit Usage Modes
The Gerrit connector supports two usage modes:
- Using Gerrit With an Issue Tracker: To reduce task list clutter and duplication, reviews with a task URL in the description are listed on their associated task instead of in the task list, and the task is decorated with the glasses icon when it has incoming reviews.
- Using Gerrit By Itself: All reviews are treated as tasks: they are shown in the task list and can be activated and scheduled.
Using Gerrit with an Issue Tracker
When using Gerrit with an issue tracker such as Bugzilla, it is more natural to treat reviews as artifacts produced while working on a task, rather than as separate tasks with their own context, scheduled date, and due date. When the Issue Tracker usage mode is selected, reviews whose commit message contains the URL of another task in the task list are considered review artifacts.
When this mode is selected, review artifacts will be shown in the task editor of the associated task instead of the task list. This way you can easily see all the reviews for the task including their incoming state. Filtering review artifacts from the task list significantly reduces clutter and incoming review noise. Review artifacts cannot be scheduled or activated; instead, schedule or activate the associated task.
Note that you will still be able search for review artifacts using the text filter in the task list.
Incoming Reviews
When a task has incoming reviews, the glasses icon will be shown next to the task in the task list:
Open the task to see which reviews have incoming changes.
Selecting a Usage Mode
The usage mode can be configured on the repository settings page as shown here:
When enabling the Issue Tracker mode, existing reviews in your task list will be converted to review artifacts the next time they are synchronized. Only reviews whose commit message contains the URL of a task in the task list will be converted; additionally, reviews with a context, scheduled date, or due date will not be converted. You can switch back to the "By Itself" mode at any time; this will cause all review artifacts to become tasks again.