Changes between Version 2 and Version 3 of TracTickets
- Timestamp:
- Jun 2, 2023 10:32:55 AM (19 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTickets
v2 v3 1 = The Trac Ticket System =1 = The Trac Ticket System 2 2 [[TracGuideToc]] 3 3 4 The Trac ticket database provides simple but effective tracking of issues and bugs within a project.4 As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues''', among others. 5 5 6 As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.6 As with the TracWiki, this subsystem has been designed to make user contribution and participation as simple as possible. Tickets can be edited, annotated, assigned, prioritized and discussed. 7 7 8 As with the TracWiki, this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements. 8 [=#edit-permissions] 9 The default installation doesn't permit to non-authenticated users ("anonymous" users) to change anything, even to comment on an issue, for obvious spam prevention reasons. Check the local contributing policy, or contact your local Trac administrator. 9 10 10 An issue is assigned to a person who must resolve it or reassign the ticket to someone else. 11 All tickets can be edited, annotated, assigned, prioritized and discussed at any time. 11 == Ticket Fields 12 12 13 == Ticket Fields == 13 A ticket contains the following information: 14 14 15 A ticket contains the following information attributes: 16 15 * '''Summary''' — Simple text without WikiFormatting. 16 * '''Description''' — The body of the ticket. Accepts WikiFormatting. 17 17 * '''Reporter''' — The author of the ticket. 18 * '''Type''' — The nature of the ticket (for example, defect or enhancement request) 18 * '''Type''' — The default types are `defect`, `enhancement` and `task`. 19 * '''Component''' — The project module or subsystem that this ticket concerns. 20 * '''Version''' — Version of the project that this ticket pertains to. 21 * '''Keywords''' — Useful for searching and report generation. 22 * '''Priority''' — The default priorities are `trivial`, `minor`, `major`, `critical` and `blocker`. A dropdown list when multiple priorities are defined. 23 * '''Severity''' — Similar to Priority, but the distinction may be useful for some projects. No severities are defined by default, therefore the field will be hidden from the ticket form. 24 * '''Milestone''' — Milestone in which the ticket will be resolved. A dropdown list. 25 * '''Assigned to/Owner''' — Principal person responsible for handling the issue. 26 * '''Cc''' — A comma-separated list of other users or email addresses to notify when changes are made to a ticket. 27 * '''Resolution''' — Reason why a ticket was closed. Default values are `fixed`, `invalid`, `wontfix`, `duplicate`, `worksforme`. 28 * '''Status''' — The statuses are defined in the [TracWorkflow#BasicTicketWorkflowCustomization ticket workflow]. For the default workflow the statuses are `new`, `assigned`, `accepted`, `closed` and `reopened`. 19 29 20 * '''Component''' — The project module or subsystem this ticket concerns. 21 * '''Version''' — Version of the project that this ticket pertains to. 22 * '''Keywords''' — Keywords that a ticket is marked with. Useful for searching and report generation. 30 '''Notes:''' 31 - The type, [trac:TicketComponent component], [TracRoadmap milestone], version, priority, severity fields and resolution can be managed using [TracAdmin trac-admin] or !WebAdmin. 23 32 24 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. 25 * '''Milestone''' — When this issue should be resolved at the latest. 26 * '''Assigned to/Owner''' — Principal person responsible for handling the issue. 27 * '''Cc''' — A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.'' 28 29 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}. 30 * '''Status''' — What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}. 31 * '''Summary''' — A brief description summarizing the problem or issue. 32 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. 33 == Changing and Commenting Tickets 33 34 34 '''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [wiki:TracAdmin trac-admin].35 With appropriate permissions, tickets can be commented and ticket properties changed. When viewing a ticket, the history of changes will appear below the ticket properties box. 35 36 36 '''Note:''' the [trac:TicketTypes type], [trac:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the [trac:WebAdmin WebAdmin] plugin.37 By default an authenticated user can edit their own ticket comments. Users with `TICKET_EDIT_COMMENT` can edit any comment. 37 38 38 '''Note:''' Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes] 39 Comment editing is meant for making small corrections to comments, like fixing formatting or spelling errors. For major edits, you should be adding a new comment instead. Editing a comment will not produce a new entry on [/timeline], while entering a new comment or other changes will do. 39 40 40 == Changing and Commenting Tickets == 41 All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket. 41 42 42 Once a ticket has been entered into Trac, you can at any time change the 43 information by '''annotating''' the bug. This means changes and comments to 44 the ticket are logged as a part of the ticket itself. 43 '''Note:''' 44 - TracLinks and WikiFormatting can be used in the ticket description and comments. Use TracLinks to refer to other issues, changesets and files. 45 45 46 When viewing a ticket, the history of changes will appear below the main ticket area.46 - See TracNotification for how to configure email notifications on ticket changes. 47 47 48 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes 49 understanding the motivation behind a design- or implementation choice easier, 50 when returning to it later.'' 48 - See TracWorkflow for information about the state transitions (ticket lifecycle), and customization of the workflow. 51 49 52 '''Note:''' An important feature is being able to use TracLinks and 53 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to 54 other issues, changesets or files to make your ticket more specific and easier 55 to understand. 50 == Hiding Fields 56 51 57 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.52 Many of the default ticket fields can be hidden from the ticket web interface by removing all the possible values through the !WebAdmin or using [TracAdmin trac-admin]. This only applies to drop-down lists: ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''. 58 53 59 '''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized. 54 == Adding Custom Fields 60 55 61 == Default Values for Drop-Down Fields == 56 Trac lets you add custom ticket fields. See TracTicketsCustomFields for more information. 62 57 63 The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section: 58 == Default Values for Drop-Down Fields 64 59 65 * `default_component`: Name of the component selected by default 66 * `default_milestone`: Name of the default milestone 67 * `default_priority`: Default priority value 68 * `default_severity`: Default severity value 69 * `default_type`: Default ticket type 70 * `default_version`: Name of the default version 71 * `default_owner`: Name of the default owner, ''if no owner for the component has been set'' 60 The option selected by default for the various drop-down fields can be set in [TracIni trac.ini]. Refer to the values prefixed with `default_` in the [[TracIni#ticket-section|"[ticket]"]] section. The default value of several fields can also be set through the !WebAdmin. 72 61 73 If any of these options are omitted, the default value will either be the first in the list, or an empty value , depending on whether the field in question is required to be set. Some of these can be chosen through the [trac:WebAdmin WebAdmin] plugin in the "Ticket System" section (others in the "trac.ini" section). The default owner for a ticket will be the component owner, if that is set, or `default_owner`, if not.62 If any of these options are omitted, the default value will either be the first in the list, or an empty value when allowed. The [[TracIni#ticket-allowed_empty_fields-option|allowed_empty_fields]] option determines which fields may have an empty value. 74 63 64 == Assign-to as Drop-Down List 75 65 76 == Hiding Fields and Adding Custom Fields == 66 If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [TracIni trac.ini] to `true`. In that case, Trac will populate the list with all users who **have an authenticated session** and possess the `TICKET_MODIFY` [TracPermissions permissions]. 77 67 78 Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [wiki:TracAdmin trac-admin]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''. 68 An authenticated session will be created the first time a user authenticates with the project. You can manually add an authenticated session using the ["TracAdmin#?session add" trac-admin] `session add` command. The `:1` suffix on the session id (i.e. username) is the key to creating an authenticated session: 69 {{{#!sh 70 trac-admin /path/to/projenv session add <sid>:1 [name] [email] 71 }}} 79 72 80 Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information. 73 You may find the dropdown list is //overpopulated// with users that are no longer active in the project. Revoking authentication privileges will not remove the session data that is used to populate the dropdown list. The [TracAdmin trac-admin] command can be used to list and remove sessions: 81 74 75 - List all sessions: 76 {{{#!sh 77 trac-admin /path/to/projenv session list 78 }}} 79 - Remove a session: 80 {{{#!sh 81 trac-admin /path/to/projenv session delete SID 82 }}} 82 83 83 == Assign-to as Drop-Down List == 84 Alternatively, you can just revoke `TICKET_MODIFY` from users that you don't want to be included in the list. However, that will not be possible if you've granted `TICKET_MODIFY` to all //anonymous// or //authenticated// users. 84 85 85 If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [wiki:TracIni trac.ini] to “true”. In that case, Trac will use the list of all users who have accessed the project to populate the drop-down field. 86 '''Notes:''' 87 - If you need more flexibility, then use subclass `ConfigurableTicketWorkflow` and override the `get_allowed_owners` method (see [trac:#12807 Trac ticket 12807]). 86 88 87 To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page, or simply by authenticating if the user has a login. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions].89 - Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page. 88 90 89 '''Note:''' See [http://pacopablo.com/wiki/pacopablo/blog/set-assign-to-drop-down Populating Assign To Drop Down] on how to add user entries at database level 91 == Preset Values for New Tickets 90 92 91 '''Note 2:''' If you need serious flexibility and aren't afraid of a little plugin coding of your own, see [http://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo] (disclosure: I'm the author) 93 To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with `variable=value` separated by `&`. Possible variables are: 92 94 93 '''Note 3:''' Activating this option may cause some performance degradation, read more about this in the [trac:TracPerformance#Configuration Trac performance] page. 95 * '''type''' — The type droplist. 96 * '''reporter''' — Name or email of the reporter. 97 * '''summary''' — Summary line for the ticket. 98 * '''description''' — Long description of the ticket. 99 * '''component''' — The component dropdown list. 100 * '''version''' — The version dropdown list. 101 * '''severity''' — The severity dropdown list. 102 * '''keywords''' — The keywords or tags. 103 * '''priority''' — The priority dropdown list. 104 * '''milestone''' — The milestone dropdown list. 105 * '''cc''' — The list of emails for notifying about the ticket change. 94 106 95 == Preset Values for New Tickets == 107 Example: `[/newticket?summary=Compile%20Error&version=1.0&component=gui]` 96 108 97 To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.109 To set the ticket owner the workflow action may also need to be selected. For the [TracWorkflow#TicketCreateAction default workflow], the //create and assign// action can be selected with `action=create_and_assign` and the owner specified by assigning `action_create_and_assign_reassign_owner`. Alternatively, you could avoid needing to select the action by using the [TracWorkflow#BasicTicketWorkflowCustomization default attribute] to make //create and assign// the default action. 98 110 99 Possible variables are : 111 For other custom workflow actions, determine the variable names by inspecting the `name` attribute of the //action// radio button and the //owner// input or select element. 100 112 101 * '''type''' — The type droplist 102 * '''reporter''' — Name or email of the reporter 103 * '''summary''' — Summary line for the ticket 104 * '''description''' — Long description of the ticket 105 * '''component''' — The component droplist 106 * '''version''' — The version droplist 107 * '''severity''' — The severity droplist 108 * '''keywords''' — The keywords 109 * '''priority''' — The priority droplist 110 * '''milestone''' — The milestone droplist 111 * '''owner''' — The person responsible for the ticket 112 * '''cc''' — The list of emails for notifying about the ticket change 113 == Deleting Tickets #deleter 113 114 114 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]] 115 Ticket delete and ticket change delete functions are enabled through an optional component. To enable the functionality edit the [TracIni#components-section "[components]"] section of TracIni: 116 {{{#!ini 117 [components] 118 tracopt.ticket.deleter.* = enabled 119 }}} 120 121 The //Delete// buttons appears next to the //Reply// buttons in the ticket description and ticket change areas. `TICKET_ADMIN` permission is required for deleting tickets and ticket changes. 122 123 Tickets and ticket changes can also be deleted using the TracAdmin `ticket remove` and `ticket remove_comment` commands. 124 125 == Cloning Tickets #cloner 126 127 The ticket clone function is enabled through an optional component. To enable the functionality edit the [TracIni#components-section "[components]"] section of TracIni: 128 {{{#!ini 129 [components] 130 tracopt.ticket.clone.* = enabled 131 }}} 132 133 The //Clone// buttons appears next to the //Reply// buttons in the ticket description and ticket change areas. The ticket summary, description and properties are cloned, with minor modifications such as changing the ticket reporter to the currently authenticated user. 115 134 116 135 ---- 117 See also: TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery136 See also: TracTicketsCustomFields, TracNotification, TracReports, TracQuery, TracRepositoryAdmin#CommitTicketUpdater