Skip to content

Latest commit

 

History

History
214 lines (155 loc) · 8.46 KB

README.md

File metadata and controls

214 lines (155 loc) · 8.46 KB
Raw

JiraKanbanMetrics

Simple command-line tool to extract Kanban metrics from Jira Agile boards using the RESTful APIs and generate charts for those metrics.

Download

Table of contents

Quick start step-by-step

Step 1: Generate a configuration file

JiraKanbanMetrics.exe configure --ConfigFile config.xml --JiraUsername MYUSER --JiraInstanceBaseAddress https://jira.YOURCOMPANY.com/jira/ --BoardId 123456

This will prompt for your Jira password:

Enter the Jira password for user 'MYUSER':
*********
Configuration file generated at: config.xml

IMPORTANT: Your password will be stored in an encrypted form using a single DES encryption and a hard-coded encryption key. For optimal security, you can opt to avoid storing your password by using the --NoStorePassword option.

Step 2: Edit the configuration file

Edit the generated config.xml file, which should look like this:

<?xml version="1.0" encoding="utf-8"?>
<JiraKanbanConfig>
  <JiraInstanceBaseAddress>https://jira.YOURCOMPANY.com/jira/</JiraInstanceBaseAddress>
  <JiraUsername>MYUSER</JiraUsername>
  <JiraPassword>4an3OGlEUd2Xr31U/w5Dhy0U0QV36LKs</JiraPassword>
  <BoardId>123456</BoardId>
  <QuickFilters></QuickFilters>
  <DefectIssueTypes>Defect</DefectIssueTypes>
  <IgnoredIssueTypes></IgnoredIssueTypes>
  <IgnoredIssueKeys></IgnoredIssueKeys>
  <QueueColumns>To Do</QueueColumns>
  <CommitmentStartColumns>To Do</CommitmentStartColumns>
  <InProgressStartColumns>In progress</InProgressStartColumns>
  <DoneColumns>Done</DoneColumns>
  <BacklogColumnName>Backlog</BacklogColumnName>
  <MonthsToAnalyse>5</MonthsToAnalyse>
</JiraKanbanConfig>

Please refer to the Configuration File section for the details about each configuration option.

Step 3: Run it

JiraKanbanMetrics.exe generate --ConfigFile config.xml

This will connect to your Jira instance, extract metrics and generate a set of ".png" files on your current working directory:

  • FlowEfficiencyChart.png
  • WeeklyThroughputChart.png
  • WeeklyThroughputHistogramChart.png
  • LeadTimeControlChart.png
  • LeadTimeHistogramChart.png
  • CumulativeFlowDiagramChart.png

Sample generated charts

FlowEfficiencyChart.png

FlowEfficiencyChart

WeeklyThroughputChart.png

WeeklyThroughputChart

WeeklyThroughputHistogramChart.png

WeeklyThroughputHistogramChart

LeadTimeControlChart.png

LeadTimeControlChart

LeadTimeHistogramChart.png

LeadTimeHistogramChart

CumulativeFlowDiagramChart.png

CumulativeFlowDiagramChart

Configuration File

The configuration file used by JiraKanbanMetrics.exe contains the following options:

  • JiraInstanceBaseAddress

    The base URL of the Jira instance. This is a mandatory configuration.

  • JiraUsername

    Your Jira username. This is a mandatory configuration.

  • JiraPassword

    Your Jira encrypted password. This configuration can only be set be using the configure command-line argument. The tool will automatically encrypt your password and store it on this configuration.

    If this configuration is not set, your password will be requested when running the tool.

  • BoardId

    The default Jira Kanban Board ID to use when generating metrics. Please notice that you can override this by using the --BoardId command-line option.

  • QuickFilters

    List of Jira "quick filter IDs" to use during the metrics extraction.

  • DefectIssueTypes

    Comma-separated list of issue types to consider as Defect. Default: Defect

  • IgnoredIssueTypes

    Comma-separated list of issue types to ignore and exclude from the metrics.

  • IgnoredIssueKeys

    Comma-separated list of issue keys to ignore and exclude from the metrics.

  • QueueColumns

    Comma-separated list of column names to consider as "queues" in the Kanban Board. Default: To Do

  • CommitmentStartColumns

    Comma-separated list of column names to consider as the "commitment start point" in the Kanban Board.

    If more than one column is configured, then the first one that the issue has passed thru will be used. Default: To Do

  • InProgressStartColumns

    Comma-separated list of column names to consider as the "work start point" in the Kanban Board.

    If more than one column is configured, then the first one that the issue has passed thru will be used. Default: In progress

  • DoneColumns

    Comma-separated list of column names to consider as the "Done" in the Kanban Board.

    If more than one column is configured, then the first one that the issue has passed thru will be used. Default: Done

  • BacklogColumnName

    Name of your "Backlog" column in the Kanban board. This is only used for the "CDF" chart. Default: Backlog

  • MonthsToAnalyse

    Number of months back in time to consider when analysing data. Default: 5

Command-line options

help:

JiraKanbanMetrics.exe help
JiraKanbanMetrics 1.0.0.0
Copyright c 2018 Rodrigo Zechin Rosauro

  configure    Creates or updates a configuration file

  generate     Generates metrics

  help         Display more information on a specific command.

  version      Display version information.

configure:

JiraKanbanMetrics.exe help configure
JiraKanbanMetrics 1.0.0.0
Copyright c 2018 Rodrigo Zechin Rosauro

  --ConfigFile                 Required. Configuration file path

  --JiraUsername               Jira User name (when not set: ask every time)

  --NoStorePassword            Indicates that an an encrypted password should NOT be stored in the configuration file or not. The password will be requested
                               every time

  --JiraInstanceBaseAddress    Base URL for your Jira instance

  --BoardId                    Jira Kanban Board ID

  --help                       Display this help screen.

  --version                    Display version information.

generate:

JiraKanbanMetrics.exe help generate
JiraKanbanMetrics 1.0.0.0
Copyright c 2018 Rodrigo Zechin Rosauro

  --ConfigFile      Required. Configuration file path

  --BoardId         Jira Kanban Board ID (when set, overrides the one in the configuration file)

  --NoCache         Disables local disk caching of Jira data

  --CacheHours      (Default: 2) Number of hours to keep cached data on disk

  --ChartsWidth     (Default: 1240) Width of the charts, in pixels

  --ChartsHeight    (Default: 780) Height of the charts, in pixels

  --help            Display this help screen.

  --version         Display version information.

Kanban Board requirements

In order to generate all the charts correctly, the following requirements must be met by the Kanban Board:

  1. It must have a columns that represents your "backlog", "pool of ideas" or similar concepts... essentially, all the stuff that you currently have cataloged but not yet commited to work on. (See the configuration option BacklogColumnName)
  2. It must have at least one column that represents your commitment point. This is when you have selected/prioritzed a work item to enter your Kanban system. (See the configuration option CommitmentStartColumns)
  3. It must have at least one column that represents "done". (See the configuration option DoneColumns)
  4. It should have individual columns for your "queues". This is optional, but it won't be able to calculate the flow efficiency without this information. (See the configuration option QueueColumns)

Tips

  • You can create a different view of you existing Jira Kanban Boards for the sole purpose of extracting metrics. Your team does not need to be tied to the restrictions of this tool.
  • For optimal performance, include in your Jira JQL filter an instruction to ignore items older than the time range that you are interested on. This will limit the number of issues that the tool need to analyse for metrics.
  • Feel free to submit pull-requests with proposed enhancements