Save GitHub issues as TSV

README.md

Save GitHub issues as TSV

This script saves GitHub issues in TSV format

Installation

The script has two software dependancies:

1. GitHub CLI for querying GitHub API
2. jq for transforming the output of the above to TSV format

There are multiple ways to install these tools. If you're using Homebrew on macOS, it's as simple as running the code snippet below:

brew install jq
brew install gh

Usage

1. Download the script
2. Make it executable

chmod +x issues2tsv.sh

3. Run it in the cloned repository

gh repo clone <organization>/<name>
# cd to the cloned repository
./issues2tsv.sh

Content

The following issue attributes are included in the TSV by default: number, title, assignees, state, url.

These are the available issue attributes, the script can be modified to include any of the following:

  assignees
  author
  body
  closed
  closedAt
  comments
  createdAt
  id
  labels
  milestone
  number
  projectCards
  reactionGroups
  state
  title
  updatedAt
  url

Output

The script outputs a TSV file named issues-<date>.tsv with content formatted like this:

number	title	assignees	state	url
<issue_number> <issue_title> <assigned_users> <issue_state> <issue_url>
<issue_number> <issue_title> <assigned_users> <issue_state> <issue_url>
<issue_number> <issue_title> <assigned_users> <issue_state> <issue_url>

issues2tsv.sh

#!/usr/bin/env bash
gh issue list --limit 10000 --state all --json number,title,assignees,state,url | jq  -r '["number","title","assignees","state","url"], (.[] | [.number, .title, (.assignees | if .|length==0 then "Unassigned" elif .|length>1 then map(.login)|join(",") else .[].login end) , .state, .url]) | @tsv' > issues-$(date '+%Y-%m-%d').tsv

Cool. With current gh 2.37.0 (2023-10-17) on Linux I was able to use the --jq option instead of installing and piping to jq

Hello, it was a great tool. I made it successfully. But when I tried to add a new field for "author" but cannot figure out the right changes.
could you kindly support the how-to? Thanks!
gh issue list --limit 10000 --state all --json number,title,author,assignees,state,url | jq -r '["number","title","author","assignees","state","url"], (.[] | [.number, .title, .author, (.assignees | if .|length==0 then "Unassigned" elif .|length>1 then map(.login)|join(",") else .[].login end) , .state, .url]) | @tsv' > issues-$(date '+%Y-%m-%d').tsv

error:
../issues2tsv/issues2tsv+author.sh jq: error (at <stdin>:1): object ({"login":"d...) is not valid in a csv row

issue resolved by below changes. Thanks!

gh issue list --limit 10000 --state all --json number,title,author,assignees,state,url | jq -r '["number","title","author","assignees","state","url"], (.[] | [.number, .title, (.author.login? // "No Author"), (.assignees | if length == 0 then "Unassigned" elif length > 1 then map(.login) | join(",") else first(.login? // "No Assignee") end), .state, .url]) | @TSV' > issues-$(date '+%Y-%m-%d').tsv