https://github.com/github/github-artifact-exporter

A set of packages to make exporting artifacts from GitHub easier
https://github.com/github/github-artifact-exporter

Last synced: 13 days ago
JSON representation

A set of packages to make exporting artifacts from GitHub easier

• Host: GitHub
• URL: https://github.com/github/github-artifact-exporter
• Owner: github
• License: mit
• Archived: true
• Created: 2020-09-03T23:20:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-09T19:49:25.000Z (over 1 year ago)
• Last Synced: 2024-05-31T01:42:12.210Z (28 days ago)
• Language: TypeScript
• Size: 3.62 MB
• Stars: 277
• Watchers: 11
• Forks: 31
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Lists

• osint_stuff_tool_collection - Github Artifact Exporter
• awesome-stars - github/github-artifact-exporter - A set of packages to make exporting artifacts from GitHub easier (TypeScript)

README

        
This project has been archived. Please use the GitHub CLI instead.

# GitHub Exporter

![Node.js CI](https://github.com/github/github-artifact-exporter/workflows/Node.js%20CI/badge.svg) ![Create release](https://github.com/github/github-artifact-exporter/workflows/Create%20release/badge.svg) ![Build and upload release assets](https://github.com/github/github-artifact-exporter/workflows/Build%20and%20upload%20release%20assets/badge.svg)

![Screenshot of the User interface](imgs/screenshot.png)

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](packages/cli)

### Core

[@github/github-exporter-core](packages/core)

### GUI

[@github/github-exporter-gui](packages/gui)

## Getting Started

### Prerequisites

1. This is a [lerna](https://github.com/lerna/lerna) project and will need the lerna CLI.

    - To install lerna globally run `npm install -g lerna`

1. Generate and export a PAT so you can pull from GPR. The PAT will need read packages scope.

    - `export NPM_TOKEN=`

### Building The Application

```bash

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](https://github.com/github/github-artifact-exporter/issues) and our [`CONTRIBUTING.md`](./CONTRIBUTING.md) to jump in.

## License

[MIT](./LICENSE)  

When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).