https://github.com/daniloqueiroz/kbtools
https://github.com/daniloqueiroz/kbtools
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/daniloqueiroz/kbtools
- Owner: daniloqueiroz
- Created: 2021-07-01T01:02:53.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-20T17:37:08.000Z (almost 5 years ago)
- Last Synced: 2025-01-26T07:14:16.533Z (over 1 year ago)
- Language: Kotlin
- Size: 62.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About kbtools
Kbtools is (for now) a small tool to extract Kanban Metrics from
Jira.
It's tailored for some specific needs:
1. Calculates throughput and cycle time for two groups of tickets: User Stories and Tasks, SubTasks and Bugs;
1. Shows the number of bugs and highest priority tickets;
1. Skips from metrics calculations any ticket with the label _skip-metrics_.
## Metrics calculation
The cycle time is calculated as the time, in days, between _In Progress_ and _Done_ statuses.
Throughput is simply a count of tickets.
# Running the tool
## Using docker
For ease of use, this project offers a helper command, `kbtools-docker`, that allows you to build and run the
project without needing `java` on your localhost, by using docker containers.
You can use `kbtools-docker build` to compile and create a docker image. Once you build the image,
just do `kbtools-docker - --help` - this will run the new generated `kbtools` docker image passing the argument
`--help` to it.
## Using your local machine
If you do have java 8+ installed on your machine, you can run the application directly using gradle:
`./gradlew run --args='--help`
## Configuring
The application requires a few environment variables to be able to connect to jira and extract the metrics.
The `kbtools-conf.example` file list and explains each of the need environment variables.
If you are running the application using the `kbtools-docker` helper, you can make a copy of the `kbtools-conf.example`
to `kbtools-conf` and add the values there. That file is going to be fed to docker as the environment files.
If you are running the application directly on your localhost, then you need to export all the required variables before
running the application.