Skip to content

Latest commit

 

History

History
75 lines (39 loc) · 3.16 KB

README.md

File metadata and controls

75 lines (39 loc) · 3.16 KB
Raw

Cosla

Get SLA metrics from your JIRA project.

$ lein run -m cosla.main time-to-close

Features

Cosla is a command-line tool that extracts data into CSV reports from Jira tickets via Jira REST API.

Example reports:

  • Time to Close The length of time (in business day hours) it took for each Jira ticket to reach "closed" state.
  • Open Per Day Number of Jira tickets still open at close-of-business each day (ending 6 PM local time).
  • Time in Status For each ticket, report the time it has spent in each of its statuses.
  • Audit Statuses (No CSV, console output only) For the configured JQL, print the statuses used by all matching tickets.

For all the CSV reports, Cosla defines "Closed" using ticket "Status" rather than "Resolution." For example, if you decide that Jira tickets are "closed" when they reach the "Awaiting Approval" status (i.e. your developers submit a ticket for stakeholder approval), you can reflect that in your Cosla reports. This is expecially useful for workflows (such as Jira's default workflow) where an issue is not actually closed when it is "Resolved."

Cosla supports a holiday calendar (via configuration) so that weekends and holidays don't count towards a Jira tickets resolution time.

Prerequsites

To build, you need to install Java and Leiningen

If you have a pre-built jar already, you only need Java to run with java -jar - no need for Leiningen. See below for instructions.

Finally, your Jira instance must support the Jira REST API, and you must have a login (NOTE: You can export your password the environment variable COSLA_PASSWORD. Cosla will detect and use that if present).

Usage

  1. Copy the example conifguration example.config.edn to a new file named config.edn, and edit it to your needs. At a minimum, you'll need to add your username, password and the JQL (Jira Query Language) clause to match your target project.

  2. Run one of the reports with:

     $ lein run -m cosla.main <report-name>

  3. You can also compile to an uberjar (all dependencies included) with:

     $ lein uberjar

and then run with

$ java -jar cosla-<version>-standalone.jar <report-name>

What Reports are Available?

Inspect the source code, or run Closa without arguments to view options:

$ lein run -m cosla.main

Configuration Format

Cosla uses edn configuration. See: https://github.com/edn-format/edn

Acknowledgements

I used the following projects/blogs as a guide for using the JIRA API from Clojure:

Thank you to Brian KimJohnson for suggesting the name Cosla.

Cosla was developed in vim using Tim Pope's vim-fireplace plugin. Check it out!

COPYRIGHT AND LICENSE

Distributed under the Eclipse Public License (1.0). See LICENSE file.

Contributions prior to 1 Sept 2017: Copyright © Novus Partners, Inc.

Contributions 2 Sept 2017 and following: Copyright held by their respective authors, per GitHub revision history.