candacebutler8879/github-artifact-exporter

A set of packages to make exporting artifacts from GitHub easier

GitHub Exporter

The GitHub Exporter is written in Typescript and provides a set of packages to make exporting artifacts from GitHub easier useful for those migrating information out of github.com

Supported artifacts that you can export are

• Issues (including filtered sub sets)

Supported formats of the export file are

• JSON Lines
• JSON
• CSV
• JIRA-formatted CSV

Packages

CLI

@github/github-exporter-cli

Core

@github/github-exporter-core

GUI

@github/github-exporter-gui

Getting Started

Prerequisites

1. This is a lerna project and will need the lerna CLI.
   • To install lerna globally run npm install -g lerna
2. Generate and export a PAT so you can pull from GPR. The PAT will need read packages scope.
   • export NPM_TOKEN=<PAT>

Building The Application

lerna clean -y
lerna exec npm install
lerna link
lerna bootstrap
# Optional, start the gui to ensure its working
lerna run start

Contributing

We welcome you to contribute to this project! Check out Open Issues and our CONTRIBUTING.md to jump in.

License

MIT
When using the GitHub logos, be sure to follow the GitHub logo guidelines.