This section covers the project management features of MantisBT. This includes features like change log, roadmap, time tracking, reporting and others.
MantisBT doesn't just track the status of issues, it also relates issues to versions. Each project can have several versions, which are marked with attributes like released and obsolete. Users typically report issues against released issues and developers typically fix issues in not released versions. With every new release comes question like: what's new? what has been fixed? Customers wonder if the new release is of interest to them and whether they should take an upgrade. Well, the change log is specifically tailored to answer these kind of questions.
In order for an issue to show up in the change log, it has to satisfy certain criteria. The criteria is that the issue has to be resolved with a 'fixed' resolution and has to have the 'fixed_in_version' field set. Users sometimes wonder why resolved or closed issues don't show up in the change log, and the answer is that the 'fixed_in_version' field is not set. Without the 'fixed_in_version', it is not possible for MantisBT to include the issues in the appropriate section of the changelog. Note that it is possible to set the 'fixed_in_version' for multiple issues using the 'Update Fixed in Version' group action on the View Issues page (just below the issues list). This option is only available when the selected project is not 'All Projects'. Once a version is marked as obsolete, it is now longer included in the change log.
MantisBT also provides the ability to customize the criteria used for an issue to be included in the change log. For example, for installations that use a custom set of resolutions, it is possible to select multiple resolutions as valid candidates for the change log. This can be done using custom functions (see custom functions documentation for more details). The custom function below overrides the MantisBT default behavior to include issues with both FIXED and IMPLEMENTED (a custom resolution) resolutions in the change log.
<?php
function custom_function_override_changelog_include_issue( $p_issue_id ) {
$t_issue = bug_get( $p_issue_id );
return ( ( $t_issue->resolution == FIXED || $t_issue->resolution == IMPLEMENTED ) &&
( $t_issue->status >= config_get( 'bug_resolved_status_threshold' ) ) );
}
MantisBT also provides the ability to customize the details to include from the issue and in what format. This can be done using the following custom function.
<?php
function custom_function_override_changelog_print_issue( $p_issue_id, $p_issue_level = 0 ) {
$t_bug = bug_get( $p_issue_id );
if( $t_bug->category_id ) {
$t_category_name = category_get_name( $t_bug->category_id );
} else {
$t_category_name = '';
}
$t_category = is_blank( $t_category_name ) ? '' : '<b>[' . $t_category_name . ']</b> ';
echo str_pad( '', $p_issue_level * 6, ' ' ), '- ', string_get_bug_view_link( $p_issue_id ), ': ', $t_category, string_display_line_links( $t_bug->summary );
if( $t_bug->handler_id != 0 ) {
echo ' (', prepare_user_name( $t_bug->handler_id ), ')';
}
echo ' - ', get_enum_element( 'status', $t_bug->status ), '.<br />';
}
By combining both customization features, it is also possible to do more advanced customization scenarios. For example, users can add a 'ChangelogSummary' custom field and include all issues that have such field in the change log. Through customizing what information being included for a qualifying issue, users can also include the 'ChangelogSummary' text rather than the native summary field.
In some cases, users know that they fixed an issue and that the fix will be included in the next release, however, they don't know yet the name of the release. In such case, the recommended approach is to always have a version defined that corresponds to the next release, which is typically called 'Next Release'. Once the release is cut and has a concrete name, then 'Next Release' can be renamed to the appropriate name and a new 'Next Release' can then be created. For teams that manage releases from multiple branches for the same project, then more than one next release can be possible. For example, 'Next Dev Release' and 'Next Stable Release'.
Another common requirement is to be able to link to the change log of a specific project from the project's main website. There is a variety of ways to do that:
To link to the changelog of version "ver1" of project "myproject":
http://www.example.com/mantisbt/changelog_page.php?project=myproject&version=ver1
To link to the changelog of all non-obsolete versions of project 'myproject':
http://www.example.com/mantisbt/changelog_page.php?project=myproject
To link to the changelog of project with id 1. The project id can be figured out by going to the management page for the project and getting the value of project_id field form the URL.
http://www.example.com/mantisbt/changelog_page.php?project_id=1
To link to the changelog of version with id 1. The version id is unique across all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
http://www.example.com/mantisbt/changelog_page.php?version_id=1
Another approach is to go to the project page and from there users can get to multiple other locations relating to the project include the change log. This can be done by a URL like the following:
http://www.example.com/mantisbt/project_page.php?project_id=1
It is possible to customize the access level required for viewing the change log page. This can be done using the $g_view_changelog_threshold configuration option.
