2.13

• When on Jira Cloud (not Data Centre or Server), we now use the v3 API to retrieve issue details because the v2 API is being removed. Data Centre and Server, on the other hand, only support the v2 API so we cannot use the v3 API with them. Until now, all Jira installations supported the same API's and this is no longer true. If you notice different behaviour in Cloud then let us know.
• When on Jira Cloud, we now have better support for the rich text formatting that is available. Cloud and Data Centre return that rich text data in very different formats and we've been focused on making cloud look good right now.
• When javascript is disabled, most of the charts won't work and a large message will be displayed at the top of the page explaining that. Despite being large, several people reported not seeing this message and not understanding why the report wasn't showing anything useful. Now that message is even more obnoxious and in your face. Javascript needs to be enabled for any of this to work.
• Atlassian has begun rolling out the naming change from Issue to Work item and this has broken some of our parsing logic. If you were seeing an error like Issue(ISSUE_ID) Can't parse link text: This work item clones OTHER_ISSUE_ID then that's now fixed.

v2.12.1

• the new Daily Chart was still marked as experimental so that's been changed. Otherwise see the release notes for 2.12.

v2.12

• New chart: [Daily View]({% link config_charts.md %}#daily_view) that is an optimized view for use during the daily standup/sprint/meeting.
• Estimation changes
  • The [sprint_burndown]({% link config_charts.md %}#sprint_burndown) and [estimate_accuracy_chart]({% link config_charts.md %}#estimate_accuracy_chart) both pull the estimate from the issue history. In the past we've looked for the field "Story Points" which works just fine in an English instance of Jira but fails for many (all?) non-English instances.
  • Also changed them to support time based estimates, if the board is configured to use them.
• Aging Work Table now shows the issue priority.
• Bug: Fixed exception when downloading for the first time and status_category_mappings are already set.
• New criteria that can be used with start_at or stop_at: first_time_visible_on_board
• Whenever we display statuses now, we display them in the format "Review":10011 rather than just Review. We do this to remove any ambiguity around which specific Review status we're talking about as there may be several.

2.11

• Aging work in progress chart - improvements
  • We've always shown the 85% point in each column so we can immediately see if an item is an outlier. We now show the 50%, 85%, 98%, and 100% points as well.
  • The CSS variable --aging-work-in-progress-chart-shading-color has been removed and replaced with four new ones for the percentile colours. This will only matter to you if you're [customizing the CSS]({% link config_file_html.md%}#css).
  • We no longer show all the columns, only those that are considered "in progress", to reduce clutter.
• Aging work table - improvements
  • In addition to the current age, we display how much longer it's likely to take to finish this. This is a forecast, based on historical data for this board.
  • If an item has a due date then we display that. We also show if we're likely to complete by that date.
• If Javascript is disabled in the browser then almost none of the charts will be visible and the report will be largely useless. We now display a warning the the top of the page if this is the case. This has been reported as a frequent problem when reports are stored on Sharepoint as it will disable javascript by default and then people are left wondering why the report isn't helpful.
• Bug: Fixed obscure exception when one issue had been blocked on another issue that isn't currently downloaded AND we were using either currently_in_status or currently_in_status_category.
• Bug: Fixed bug where info was only being written to the log and not to the console, making it seem if it weren't working at all.
• info improvement: Statuses now list the id of the status as well as the name.
• Jira will happily let you create two columns on a board with the same name. Unfortunately there are no id's with those columns so there is now no way to tell them apart. This change will add a numerical suffix such as Backlog-2 to duplicate columns so that we're able to work with them.

v2.10

• Cycletime Histogram improvements
  • Added a collection of statistics under the chart. Thanks to Fernando Cuenca for the contribution.
  • Added percentile lines on the chart.
• Bug: Fixed exception in rare case when comparing output rows
• Bug: Fixed some timezone logic, for which the unit tests only failed when being run somewhere other than the Pacific Timezone.

v2.9.1

• Fixed an exception when running the tool for the very first time.

v2.9

• Status/category mappings have been an ongoing pain point for a long time. When a status gets removed from Jira, all of a sudden the reports can't be generated until someone sets up a status_category_mapping and it isn't always obvious what the values should be. We are now much better at guessing the correct mapping and will use that guess where we can. You will see suggestions in the output, where we guessed and what values we used.
• Bug: Fixed an exception in the data quality report when a status can't be found at all.
• On StatusCollection, there used to be methods todo, in_progress, and done that would return the names of statuses that matched those categories. Since we now know that names aren't unique, those methods have just been removed. They hadn't been documented before and were never officially supported so we aren't going through a deprecation process.
• Bug: Fixed case where the quality report didn't always correctly warn about items that had been moved back to the backlog.
• Whenever a status or status-category is specified, we can do a better job of identifying typos.
• The methods first_time_in_status_category, still_in_status_category, and currently_in_status_category...
  • ...will now accept names ("Done"), name/ID pairs ("Done:3"), or just ID's ("3"). If the name and ID are both specified then we will verify that they match and raise an error if they don't.
  • ...will also accept one of the following keys :new, :indeterminate, or :done to reflect the three categories. The code had previously worked only with names but those names will change in non-English installations of Jira so the keys are better.
    • Why is it called "indeterminate"? That's a question for Atlassian; we just use the key names that Jira uses internally.
• standard_project now uses the keys, which should make things easier for non-English instances.
• Added a quality check for the case where an issue is identified as being blocked by another issue and yet that other issue is already closed. This is clearly a mistake and the quality report will now show it.

2.8

The main focus of this release is improving the experience with better error messages, and more helpful suggestions.

• Bug: It wasn't possible to clear the description or title texts on individual charts.
• Added first_time_label_added for determining start or end times.
• Moved the generated timestamp of the report to the footer.
• Added the version number of JiraMetrics to the footer so there's a record of what version of the tool was used for this particular report.
• no_earlier_than previously only worked during the download stage and this proved to be confusing as there was no effect when just doing an export. It now works at both points and should be clearer as to what is actually happening.
• All the methods like first_time_in_status used to return a Time object and now return the ChangeItem that happened at that time. Unless you're writing your own methods, you likely won't even be aware that anything changed here. If you are, then you'll get a warning when returning a Time. The reason for this change is to give more context that will be useful in future reporting.
• Bug: We've discovered that Jira allows for multiple statuses with the same name and when this happens, it broke some of our existing logic. Fixes for this case have been added.
  • In standard_project, when specifying status_category_mappings, it's now possible to specify the ID at the same time as the name. "Review" will continue to specify just the name and "Review:4" will specify the name and also an ID of 4.
  • Status ID's are now mandatory and the tool will do it's best to guess the correct one, however it won't be able to guess in every case and you'll now get a error when it can't.
• Bug: some status category logic was failing in non-English instances of Jira because we were relying on category names, rather than keys. We think we've caught all the cases of this.

v2.7.3

• Fixed an exception when two scrum projects had overlapping names like myproject and really_myproject. Our matcher wasn't precise enough and was matching where it shouldn't have.

v2.7.2

• Fixed a regression that prevented a new full download from working. Incremental downloads hadn't been affected.

Previously fixed in 2.7.1 but that hadn't been tracked.

• All documentation has been moved from the Github wiki to this site that you're looking at now. There are places in the code where error messages refer to specific pieces of documentation and they've been updated to point to the new place.
• Cleaned up the look, and implementation of the data quality report.