gh2csv

Collection of scripts to export GitHub data into CSV

Repos in an Organization
PRs and PR Comments for a given Repo
Issues and Issues Comments for a given Repo
Contributors for a given Repo
Events for a given Repo

Note, the provided PR, PR Comments, Issues, and Issue Comments export only the basic events, you can alter the fields names to include additional data needed for your use-case.

Prerequisites

Setup

Exporting your GitHub token as environment variables

export GITHUB_ACCESS_TOKEN="your-token-here"

Export

Each one of the below scripts uses paging to export all of the data from the inception of that repo. Depending on the size of your repo, that may take a while. You can experiment with the starting page number in each script to start with a more recent records.

Org Repos

bin/repo org_name

https://docs.github.com/en/rest/repos/repos

Outputs CSV file (repo-org_name.csv) containing:

repo - name of the repo
org - organization name
url - fully qualified URL of the repo in GitHub
home - homepage from repo settings
lang - language from repo settings
license - the type of of license used in the repo (e.g. apache-2.0)
update - last update date (yyy-MM-dd)
desc - repo description from settings

PRs

bin/pr [org_name] [repo_name]

https://docs.github.com/en/rest/pulls/pulls

Outputs CSV file (pr-org_name-repo-name.csv) containing:

id - numeric identifier for that PR
number - sequential number of that PR
state - current state fo that PR (open, closed)
repo - name of the repo
org - organization name
user - username who submitted the PR
created - ISO timestamp of when the PR was created
updated - ISO timestamp of when the PR was updated
merged - ISO timestamp of when the PR was merged
closed - ISO timestamp of when the PR was closed
title - PR tile at that time
labels - Comma-separated list of labels

The pr command also exports PR Reviews for each one of the PRs into CSV file (prr-org_name-repo-name.csv) containing:

https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request

id - numeric identifier for that PR review
number - number of the PR
state - current state fo that PR review
repo - name of the repo
org - organization name
user - username who submitted the PR review
submitted - ISO timestamp of that PR review
association - author association (CONTRIBUTOR, MEMBER etc)

PR Comments

bin/prc [org_name] [repo_name]

https://docs.github.com/en/rest/pulls/comments#list-review-comments-in-a-repository

Outputs CSV file (prc-org_name-repo-name.csv) containing:

id - numeric identifier for that PR comment
number - number of the PR
review_id - request review ID
in_reply_to_id - numeric identifier for the PR
position - order of the comment in the context of the PR
repo - name of the repo
org - organization name
author - username who made the PR comment
association - author association (CONTRIBUTOR, MEMBER etc)
created_at - comment creation timestamp
updated_at - comment update timestamp

Issues

bin/issue [org_name] [repo_name]

https://docs.github.com/en/rest/issues/issues#list-repository-issues

Outputs CSV file (issue-org_name-repo-name.csv) containing:

id - numeric identifier for that issue
number - number of the issue
state - current state fo that PR review
repo - name of the repo
org - organization name
author - username who created the issue
created - ISO timestamp of when the issue was created
closed - ISO timestamp of when the issue was closed
title - PR tile at that time
labels - Comma-separated list of labels

Issue Comments

bin/issuec [org_name] [repo_name]

https://docs.github.com/en/rest/issues/comments#list-issue-comments-for-a-repository

Outputs CSV file (issuec-org_name-repo-name.csv) containing:

id - numeric identifier for that issue comment
number - number of the issues
repo - name of the repo
org - organization name
author - username who made the issue comment
updated - ISO timestamp of the issue comment was last updated
association - comment author association (role)

Contributors

bin/contrib [org_name] [repo_name]

https://docs.github.com/en/rest/repos/repos#list-repository-contributors

Outputs CSV file (contrib-org_name-repo-name.csv) containing:

id - numeric identifier for that issue comment
repo - name of the repo
org - organization name
user - username who made the issue comment
admin - whether the user is a repo admin
num - number of contributions to this repo made by that user

Events

Note: Only events created within the past 90 days will be included in timelines.

bin/event 
[org_name] [repo_name]

https://docs.github.com/en/rest/activity/events

Outputs CSV file (event-org_name-repo-name.csv) containing:

id - numeric identifier for that event
repo - name of the repo
org - organization name
user - the actor (user) that caused that event
type - the type of the event (e.g. PushEvent)
time - ANSI timestamp of this event

Disclaimer

This is my personal project and it does not represent my employer. I take no responsibility for issues caused by this code. I do my best to ensure that everything wor

denisgolius/gh2csv