Reports (Insights)
Renaming “Releases“ to “Packages“
As of June, 2024 we re renaming “Releases“ to “Packages“ to be aligned with our Cloud products and avoid long running confusion with “Releases“ in Jira. Some areas of our App will still have release notion/naming due to technical limitations, namely:
API roots will still be called / release / while tags and descriptions in Swagger changed to packages
Webhook injectable variables will be called entity.*
Release notes injectable variables will be called release.*
JQL functions will still be called versionsOfReleases.. & issuesOfReleases..
Topics
- 1 Renaming “Releases“ to “Packages“
- 2 Reports for Versions
- 2.1 Version Burnup Chart
- 2.1.1 Scope
- 2.1.2 Report configuration
- 2.1.3 Report content
- 2.1.4 Export to CSV
- 2.2 Version Trends Report
- 2.2.1 Scope
- 2.2.2 Report configuration
- 2.2.3 Report content
- 2.1 Version Burnup Chart
- 3 Reports for Packages
- 3.1 Package Burnup Chart
- 3.2 Package Trends Report
- 3.2.1 Scope
- 3.3 Package Status Report
- 4 Other Reports
- 4.1 Scope Change Report
- 4.1.1 Scope
- 4.2 Board StatisticsÂ
- 4.2.1 Reports configuration
- 4.2.2 Report content
- 4.3 Milestones Reports
- 4.1 Scope Change Report
- 5 More "Reports"?
Reports for Versions
Version Burnup Chart
Scope
Only applicable for Fix Versions as we can't yet track history for Virtual Versions.
Version burnup report helps you to monitor version scope and development progress over time. It also allows spotting expected or unexpected scope changes and version progress trend.Â
Report configuration
User can choose any version in the board using version selector:
Available units are:
Issue count
Original time estimate
Story points (Jira software only)
Â
User can adjust report output via custom JQL queries:
Few popular Use Cases:
New features and technical improvements burnup | issueType in (Epic, Story, Task)Â | Â |
Exclude sub-tasks | issueType in standardIssueTypes() | Â |
Burnup for assignee | assignee was <user_name> | Â |
Â
Also, user can choose from additional drawing options:
Draw version from the start date. If the option is enabled, the report is drawn from the version start date. Otherwise, from the date when the first item was added into the version.Â
Â
Show status changes. Outlines version transitions from one status to another one. Please see the example (3) on the screenshot below.
Report content
Total scope of the version calculated on a daily base in selected units
Done scope of the version
Guideline. Shows ideal burnup rate in order to complete version in time.Â
Â
Version and release forecast. Draw optimistic, realistic and pessimistic guidelines based on the projected release date. Please read more details on how the projected release date calculated in FAQ
Â
Start date. Indicates version start date
Release date. Indicates version release date
Version status change. Indicates when the version was moved from one column to another one. The details are available on mouse-over.Â
Export to CSV
Total scope and amount of done items could be exported in CSV format using button.
The resulted document structure is:
"Date","Total","Completed"
"2019/10/28","87","16"
Â
Version Trends Report
This report helps to outline scope change and velocity trends of the version.Â
Report configuration
Following configuration parameters are available:
Version selector. Choose a version for which the report will be built.
Data aggregation interval. The user can choose an interval for which the data will be aggregated in the report. Available options:
Day
Week
Month Â
Unit. Supported units are:
Issue count
Story points
Original time estimate
JQL. The report content could be adjusted via custom JQL function.
Done items switcher. Turn on/off done items trend (meaning: version velocity)
Scope change switcher. Turn on/off scope change trend.Â
Draw from start date. If the option is enabled, the report is drawn from the version start date. Otherwise, from the date when the first item was added into the version.Â
Â
Description | JQL | Units |
---|---|---|
Bugs trend report | issueType=Bug | Issue count |
Version velocity | issueType in standardIssueTypes() | Any |
Business value trend | issueType in (Task, Story, Epic) | Issue count or Story Points |
Performance per person | assignee was <user_name> | Any |
Report content
The report has the following content:
Period of the data aggregation. Te values are calculated by the formula: <# of items in period>= <# of items at the end of the period> - <# of items at the start of the period> +1 dayÂ
Scope change trend line.
Velocity trend line.
Scope change and velocity for the current period are outlined with a dotted line.
Reports for Packages
Package Burnup Chart
Package burnup chart is similar version burnup. It consists of two main parts:
Cumulative scope. The chart shows the cumulative scope and progress for all the versions in the package on a daily base
Separate charts for each version on the package.Â
Report logic is similar to versions burnup.
Package Trends Report
Package trends report is similar version trends report. It consists of two main parts:
Cumulative trends for all version in the package.Â
Separate trends for each version in the package.Â
Package Status Report
Package status report helps users to understand the status of the package and all its versions.
The following information about the package and its versions is available:
Status
Issues progress
Start date
Release date
Projected release date
User can select any package available in the Release Board using the Package selector:
Â
Other Reports
Scope Change Report
Scope change report helps users to identify the issues that caused affect on the scope of a version or package.
The report has two sections:
Added issues - issues which were added to the target version or package during a specified periodÂ
Removed issues -Â issues which were removed from the target version or package during a specified period
Report parameters include:
Target version or package
Predefined date periods with the option to specify custom start and end dates
Filter by issue types
The following issues details are displayed:
Issue type, key, summary
Status
Priority
Currently assigned versions from "fixVersions" field
Story points
Original, remaining and logged work (hours)
The total number of issues in each section is displayed together with the Sum of Story Points and Time Tracking fields.
Board StatisticsÂ
The report shows the number of transitions into each column for version and package.
Reports configuration
User is able to define the following configuration parameters:
Period. Defines a period for which the statistic will be generated.
Count multiple transitions to the same column.
If the option is enabled, multiple transitions of a particular version or package to the same column will be counted. Otherwise, only unique transitions will be counted. Example: version "V3" was moved 3 times to "Done" column. If the option is enabled: we will see that transition was done 3 times, if disabled - only once.Â
Report content
Statistics for all versions in the board
Statistics for all packages in the board
Number of versions or packages which were moved to a particular status during the selected period
Transition detail button. It opens a pop-up with all transitions to the selected status.
Â
Â
Export to CSV
Milestones Reports
Milestone report gives you an aggregated view on all milestones of package and its associated versions.Â
To open the report choose "Milestones" in "Switch report" drop down.
Â
Choose one or several of your packages and/or versions to generate the report.
How to read track bar?
Achieved states for milestones achieved at a date <= planned date
Achieved with delay states for milestones ticked as achieved at a date > planned date
On track means not yet achieved, but the planned date is in future (or empty)
Delayed means not yet achieved with planned date in the past
Adjustments and configuration
You can adjust the output by configuring some predefined filters:
Delayed will shortlist only delayed milestones, not delayed or ALL
Achieved will shortlist only achieved milestones, not achieved or ALL
By clicking on "Export to CSV" you can download the output
Â
If you want to go into further details and see version specific milestones toggle "Show details"Â at the bottom of the report.
More "Reports"?
In the "More reports" section we compiled the list of reports that we want your feedback and votes for.
Click the "Vote" button to let us know which on you find particularly useful.
Report | Description |
---|---|
Package & Version Burndowns | Track the total work remaining and project real release date. This helps you to manage package or version progress and respond accordingly. |
Package Velocity Chart | Control your package velocity over time through each particular version velocity monitoring. Identify velocity degradation and potential delays upfront. |
Suggest your report
We are open to your feedback! If you have an idea or need any other report, please let us know using the simple feedback form:
Report name - required field
Report description - required field
Your email - this is optional if you want to let us know to contact you about your suggestion.