Bug tracking is one of the most obvious uses of trackers in Tiki. They are very simple, and yet they take many steps to configure. This profile will enable the tracker feature and create a basic bug tracker to which you will be able to add additional fields.
Bug trackers are typically accessible to the whole community. We want people to check if a bug has already been logged before adding a new one. This is different than an
Issue_Tracker.
This page will be created:
Profile_Bug_tracker_15_bug_page
This profile can be extended to use the custom search plugin using the
Bug_Tracker_Search profile.
YAML
preferences:
feature_trackers: y
feature_user_watches: y
feature_syntax_highlighter: y
feature_syntax_highlighter_theme: default
ajax_inline_edit: y
feature_jquery_tablesorter: y
feature_wiki_argvariable: y
tracker_change_field_type: y
tracker_clone_item: y
tracker_show_comments_below: y
trackerfield_dropdownother: y
wikiplugin_pivottable: y
instructions: Profile_Bug_tracker_15_bug_page
objects:
-
type: tracker
ref: bug_tracker
data:
name: Bugs
description: Standard bug tracker
sort_default_order: desc
hide_list_empty_fields: y
restrict_end: 0
restrict_start: 0
allow:
- comments
show:
- creation_date
- list_modification_date
- modification_date
- status
-
type: tracker_field
ref: bug_tracker_summary
data:
name: Summary
permname: bug_tracker_summary
tracker: $profileobject:bug_tracker$
options:
samerow: 1
type: text_field
order: 0
flags:
- link
- list
- searchable
- public
- mandatory
-
type: tracker_field
ref: bug_tracker_severity
data:
name: Severity
permname: bug_tracker_severity
tracker: $profileobject:bug_tracker$
options:
options:
- 5=fatal
- 4= major
- 3=normal
- 3=normal
- 2=minor
- 1=text
- other=Other
type: dropdown_other
order: 10
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_priority
data:
name: Priority
permname: bug_tracker_priority
tracker: $profileobject:bug_tracker$
options:
options:
- 5=5 (high)
- 4=4
- 3=3
- 3=3
- 2=2
- 1=1 (low)
type: dropdown
order: 20
visible: admin_editable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_bug_status
data:
name: Bug status
permname: bug_tracker_bug_status
tracker: $profileobject:bug_tracker$
options:
options:
- new
- new
- feedback
- acknowledged
- confirmed
- resolved
- wontfix
- worksforme
- other
type: dropdown_other
order: 30
visible: creator_editable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_version
data:
name: Version
permname: bug_tracker_version
tracker: $profileobject:bug_tracker$
options:
options:
- 1.x
- 2.x
- 3.x
- 4.x
- 5.x
- trunk
type: multiselect
order: 40
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_description
data:
name: Description
permname: bug_tracker_description
tracker: $profileobject:bug_tracker$
options:
toolbars: 1
distinct: n
wysiwyg: n
samerow: 1
type: text_area
order: 50
flags:
- searchable
- public
- mandatory
-
type: tracker_field
ref: bug_tracker_expected_behaviour
data:
name: Expected behaviour
permname: bug_tracker_expected_behaviour
tracker: $profileobject:bug_tracker$
options:
toolbars: 1
width: 80
height: 5
max: 10000
listmax: 200
distinct: n
wysiwyg: y
samerow: 1
type: text_area
order: 60
flags:
- searchable
- public
-
type: tracker_field
ref: bug_tracker_submitted_by
data:
name: Submitted by
permname: bug_tracker_submitted_by
tracker: $profileobject:bug_tracker$
options:
autoassign: 1
groupIds:
- 0
canChangeGroupIds:
- 0
type: user
order: 70
visible: immutable
flags:
- searchable
- public
-
type: tracker_field
ref: bug_tracker_assignee
data:
name: Assigned to
permname: bug_tracker_assignee
tracker: $profileobject:bug_tracker$
options:
groupIds:
- 0
canChangeGroupIds:
- 0
type: user
order: 80
visible: admin_editable
flags:
- list
- searchable
- public
-
type: tracker_option
ref: bugs_sort_default_field
data:
tracker: $profileobject:bug_tracker$
name: sort_default_field
value: modification
-
type: tracker_option
ref: bugs_popup_fields
data:
tracker: $profileobject:bug_tracker$
name: popup_fields
value: >
$profileobject:bug_tracker_assignee$,$profileobject:bug_tracker_description$,$profileobject:bug_tracker_expected_behaviour$,$profileobject:bug_tracker_submitted_by$
Sample data
YAML
objects:
-
type: tracker_item
ref: bug_001
data:
tracker: $Bug_Tracker_15:bug_tracker
status: open
values:
- [ $Bug_Tracker_15:bug_tracker_summary, The application crashed ]
- [ $Bug_Tracker_15:bug_tracker_severity, 5 ]
- [ $Bug_Tracker_15:bug_tracker_priority, 3 ]
- [ $Bug_Tracker_15:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_15:bug_tracker_version, trunk ]
- [ $Bug_Tracker_15:bug_tracker_description, "This bug was created as part of the sample data for Bug_Tracker_15, and it refers to a critical bug that prevent the application from running at all. However, since it only affects the trunk (development) version, it doesn't have the maximum priority to be debugged." ]
- [ $Bug_Tracker_15:bug_tracker_expected_behaviour, "Keep the ~~red,lightyellow:application~~ running __without crashing__" ]
- [ $Bug_Tracker_15:bug_tracker_submitted_by, admin ]
- [ $Bug_Tracker_15:bug_tracker_assignee, admin ]
-
type: tracker_item
ref: bug_002
data:
tracker: $Bug_Tracker_15:bug_tracker
status: pending
values:
- [ $Bug_Tracker_15:bug_tracker_summary, One menu option does nothing ]
- [ $Bug_Tracker_15:bug_tracker_severity, 4 ]
- [ $Bug_Tracker_15:bug_tracker_priority, 4 ]
- [ $Bug_Tracker_15:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_15:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_15:bug_tracker_description, "Going to Tools > Help does nothing and no contextual help is shown." ]
- [ $Bug_Tracker_15:bug_tracker_expected_behaviour, "Get the ~~blue,lightgrey:contextual help~~ to __show up__ as usual" ]
- [ $Bug_Tracker_15:bug_tracker_submitted_by, admin ]
- [ $Bug_Tracker_15:bug_tracker_assignee, admin ]
-
type: tracker_item
ref: bug_003
data:
tracker: $Bug_Tracker_15:bug_tracker
status: open
values:
- [ $Bug_Tracker_15:bug_tracker_summary, Some strings are shown in italics by mistake ]
- [ $Bug_Tracker_15:bug_tracker_severity, 1 ]
- [ $Bug_Tracker_15:bug_tracker_priority, 2 ]
- [ $Bug_Tracker_15:bug_tracker_bug_status, acknowledged ]
- [ $Bug_Tracker_15:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_15:bug_tracker_description, "Only aesthetics changed, all features work as expected" ]
- [ $Bug_Tracker_15:bug_tracker_expected_behaviour, "Keep the same -+non-italics+- font" ]
- [ $Bug_Tracker_15:bug_tracker_submitted_by, admin ]
- [ $Bug_Tracker_15:bug_tracker_assignee, admin ]
-
type: tracker_item
ref: bug_004
data:
tracker: $Bug_Tracker_15:bug_tracker
status: closed
values:
- [ $Bug_Tracker_15:bug_tracker_summary, The application didn't start at all ]
- [ $Bug_Tracker_15:bug_tracker_severity, 5 ]
- [ $Bug_Tracker_15:bug_tracker_priority, 5 ]
- [ $Bug_Tracker_15:bug_tracker_bug_status, resolved ]
- [ $Bug_Tracker_15:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_15:bug_tracker_description, "Critical issue that prevented the from running at all in usual desktops" ]
- [ $Bug_Tracker_15:bug_tracker_expected_behaviour, "Allow the app to __run as usual__" ]
- [ $Bug_Tracker_15:bug_tracker_submitted_by, admin ]
- [ $Bug_Tracker_15:bug_tracker_assignee, admin ]
-
type: tracker_item
ref: bug_005
data:
tracker: $Bug_Tracker_15:bug_tracker
status: open
values:
- [ $Bug_Tracker_15:bug_tracker_summary, Not localized/translated to my mother tonge ]
- [ $Bug_Tracker_15:bug_tracker_severity, 3 ]
- [ $Bug_Tracker_15:bug_tracker_priority, 3 ]
- [ $Bug_Tracker_15:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_15:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_15:bug_tracker_description, "Critical issue that prevented the from running at all in usual desktops" ]
- [ $Bug_Tracker_15:bug_tracker_expected_behaviour, "Get it in my local language also when I select it (or through ~~red:the language~~ in ''my OS'')" ]
- [ $Bug_Tracker_15:bug_tracker_submitted_by, admin ]
- [ $Bug_Tracker_15:bug_tracker_assignee, ]
Modules
YAML
objects:
-
type: module
ref: module_last_modif_tracker_items
data:
name: last_modif_tracker_items
groups: [ Anonymous, Registered ]
position: left
order: 5
params:
trackerId: $Bug_Tracker_15:bug_tracker
name: Summary
This will include:
Profile_Bug_tracker_bug_page
YAML
instructions: Bug_Tracker_15
preferences:
enable: [ feature_wiki ]
objects:
-
type: wiki_page
ref: bug_tracker_page
data:
name: Bug_Tracker_15
description: What needs to be done
lang: en
content: wikicontent:Profile_Bug_tracker_15_bug_page
Plugin to embed bug information in pages
YAML
objects:
-
type: plugin_alias
data:
name: bug
implementation: trackerlist
description:
name: Bug Embed
description: Displays a bug's information inside a wiki page
prefs: [ feature_trackers ]
params:
id:
name: ID
description: Bug ID matching the tracker item ID
required: true
filter: digits
body:
input: ignore
params:
trackerId: $bug_tracker
fields: $profileobject:bug_tracker_summary$:$profileobject:bug_tracker_severity$:$profileobject:bug_tracker_priority$:$profileobject:bug_tracker_bug_status$:$profileobject:bug_tracker_version$:$profileobject:bug_tracker_description$:$profileobject:bug_tracker_expected_behaviour$:$profileobject:bug_tracker_submitted_by$:$profileobject:bug_tracker_assignee$
showlinks: "y"
showstatus: "y"
status: opc
max: 1
showlastmodif: "n"
showfieldname: "n"
itemId:
pattern: %id%
params:
id:
default: 0
Todo
- Fix bug/feature about multiple installs
proposed structure
fields:
- summary
- severity
- fatal,major,normal,normal,minor,text
- Priority
- only admin/dev-member can change
- 1,2,3,3,4,5
- status
- only admin/dev-member and creator can change
- new,new,feedback,acknowledged,confirmed,resolved,wontfix,worksforme
- version
- description
- expected behaviour
- submitted by
- not changeable (Immutable after creation)
- assigned to
- only admin/dev-member can change