jira-timespent-report

Jira Cloud で検索した Jira 課題のレポートを生成する

Jira 課題の検索結果をエクスポートするやり方だと「初期見積もり」と「消費時間」の単位がそろっていないため、自分で工数に変換するのが面倒です。

そこで、検索した Jira 課題の工数を変換するツールを作成してみました。

参考情報

• Jira Cloud の REST API
• REST API の利用例

準備

Jira Cloud の REST API へアクセスするときは、リクエストに認証情報を指定します。 具体的には、 Authorization ヘッダーに BASIC 認証形式^1の値を指定します。こういう感じです。 ただし、パスワードの代わりに Atlassian Cloud で生成する API Token^2を使います。

Authorization: Basic dGVzdDp0b2tlbgo=

なので、ツールを実行する前に API Token を作成しておく必要があります。

仕様

• Windows 10 で実行できる
• 認証情報(ユーザーIDとAPI Token)は環境変数で指定する
• 接続先 URL はコマンドライン引数で指定する
• REST API のバージョンはコマンドライン引数で指定する (初期値は 3 )
• 1回の検索あたりの結果取得数はコマンドライン引数で指定する (初期値は 50 )
• 作業ログを取得するかどうかはコマンドライン引数で指定する (初期値は 取得しない )
• 対象年月は yyyy-MM 形式でコマンドライン引数で指定する (初期値は前月)
• 検索フィルターIDはコマンドライン引数で指定する
• 検索条件のJQLはコマンドライン引数で指定する
  • 対象年月を指定した場合
    • 検索条件に updated が指定されていなければ自動的に追加する
  • 対象年月を指定した場合
    • 作業ログを指定した場合、検索条件に worklogDate が指定されていなければ自動的に追加する
  • 検索フィルターIDを指定した場合
    • 検索条件で指定したJQLを上書きする
• フィールド名はコマンドライン引数で指定する
  • 作業ログを指定した場合は固定 ( key,started,displayName,emailAddress,timeSpentSeconds )
• 「初期見積もり」や「消費時間」を秒単位から変換する単位はコマンドライン引数で指定する
  • サブタスクがある Jira 課題には「Σ初期見積もり」と「Σ消費時間」の値が設定される
• 出力形式はヘッダーありの CSV

ツールの導入

go get bitbucket.org/yujiorama/jira-timespent-report

使い方

CLI

コマンドとして実行、CSV 形式で標準出力へ出力する。

$ AUTH_USER=yyyy AUTH_TOKEN=aaaabbbb jira-timespent-report -url https://your-jira.atlassian.net -maxresult 10 -unit dd -query "status = Closed" -targetym 2020-08

Web

HTTP サーバーとして実行、CSV 形式でダウンロードする。

$ AUTH_USER=yyyy AUTH_TOKEN=aaaabbbb jira-timespent-report -server &
$ curl localhost:8080/?url=https://your-jira.atlassian.net&maxresult=10&unit=dd&query=status+%%3DClosed&targetym=2020-08

オプションの説明

$ jira-timespent-report -h
Usage of jira-timespent-report (v0.0.9):
  $ jira-timespent-report [options]

Example:
  # get csv report by cli
  $ AUTH_USER=yyyy AUTH_TOKEN=aaaabbbb jira-timespent-report -url https://your-jira.atlassian.net -maxresult 10 -unit dd -query "status = Closed" -targetym 2020-08

  # get csv report by http server
  $ AUTH_USER=yyyy AUTH_TOKEN=aaaabbbb jira-timespent-report -server &
  $ curl localhost:8080/report?url=https://your-jira.atlassian.net&maxresult=10&unit=dd&query=status+%3DClosed&targetym=2020-08

Options:
  -api string
        number of API Version of Jira REST API (default "3")
  -days int
        work days per month (default 24)
  -fields string
        fields of jira issue (default "summary,status,timespent,timeoriginalestimate,aggregatetimespent,aggregatetimeoriginalestimate")
  -filter string
        jira search filter id
  -host string
        request host (default "localhost")
  -hours int
        work hours per day (default 8)
  -maxresult int
        max result for pagination (default 50)
  -port int
        request port (default 8080)
  -query string
        jira query language expression (default "status = Closed AND updated >= startOfMonth(-1) AND updated <= endOfMonth(-1)")
  -server
        server mode
  -targetym string
        target year month(yyyy-MM)
  -unit string
        time unit format string (default "dd")
  -url string
        jira url (default "https://your-jira.atlassian.net")
  -worklog
        collect worklog toggle

ライセンス

MIT