JIRA Reporter
Installation
$ go install github.com/mattrx/jira-reporter
Usage
$ jira-reporter -e <endpoint>
Usage:
jira-reporter [command]
Available Commands:
help Help about any command
sprint-report Generate a sprint report
Flags:
-e, --endpoint string jira endpoint
-h, --help help for jira-reporter
Use "jira-reporter [command] --help" for more information about a command.
The connect to your JIRA instance you have to provide the URL as the endpoint
parameter (e.g. https://issues.apache.org/jira/
). To authenticate with your JIRA instance you have to provide the env variables USERNAME
and PASSWORD
.
Reports
Sprint Report
Usage:
jira-reporter sprint-report [flags]
Flags:
--boardID int32 board id
-h, --help help for sprint-report
--manHours float man hours in sprint (default 400)
--projectKey string project key
Global Flags:
-e, --endpoint string jira endpoint
You have to either provide a projectkey
or a boardID
parameter. If a projectKey
is given and the project has more than one scrum board a selection is printed.
If a boardID
is given or there is only one scrum board for the given projectKey
than this board is automatcally selected.
After that a selection of the last 10 sprints is printed and you have to choose for which you want the sprint report to be generated.
You can also provide the manHours
parameter that is used when calculating the sprint velocity. The default is 10 people with a 40 hour week.
The asterisk after the story points value is used to indicate which issues count towards the scope change kpi.
Example
$ jira-reporter sprint-report --projectKey <projeyKey> --manHours <manHours>
0 ) Aquaman (Closed)
1 ) Batman (Closed)
2 ) Catwoman (Closed)
3 ) Deadpool (Closed)
4 ) The Flash (Closed)
5 ) Green Lantern (Closed)
6 ) Hancock (Closed)
7 ) Ironman (Closed)
8 ) Joker (Bad Guy) (Active)
9 ) Killer Croc (Bad Guy) (Future)
Select Sprint: 7
-------------------------------------------------------------------------------
Sprint: Ironman (Closed)
Start: Thu, 21 Nov 2019 11:21:30 UTC
End: Wed, 27 Nov 2019 16:24:35 UTC
Key Summary Status Story Points
CSI-8089 Funktion der Schnittstelle prüfen Closed 2
CSI-8036 Anpassung ResponseTransformer Closed 3 *
CSI-8087 Job Monitoring In Progress 5
Planned: 7 SP 2 I
Planned (Completed): 2 SP 28.57% 1 I 50.00%
Planned (Not Completed): 5 SP 71.43% 1 I 50.00%
Unplanned: 3 SP 1 I
Unplanned (Completed): 3 SP 100.00% 1 I 100.00%
Unplanned (Not Completed): 0 SP 0.00% 0 I 0.00%
Scope Change Story Points: 42.86%
Scope Change Issues: 50.00%
Man Hours in Sprint: 40
Velocity: 0.13 SP/mHour, 1.00 SP/mDay
Velocity: 0.05 I/mHour, 0.40 I/mDay