Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benbalter/github_records_archiver
Backs up a GitHub organization's repositories and all their associated information for archival purposes.
https://github.com/benbalter/github_records_archiver
backup data-liberation data-migration data-portability export github
Last synced: about 2 months ago
JSON representation
Backs up a GitHub organization's repositories and all their associated information for archival purposes.
- Host: GitHub
- URL: https://github.com/benbalter/github_records_archiver
- Owner: benbalter
- License: mit
- Archived: true
- Created: 2016-01-08T20:31:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-23T15:28:13.000Z (over 3 years ago)
- Last Synced: 2024-10-14T07:54:46.053Z (2 months ago)
- Topics: backup, data-liberation, data-migration, data-portability, export, github
- Language: Ruby
- Size: 120 KB
- Stars: 108
- Watchers: 8
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
**This project is no longer maintained. If you are interested in archiving your user or organization data, please use the purpose-built [migration API](https://developer.github.com/changes/2018-05-24-user-migration-api/) instead.**
---
# GitHub Records Archiver
[](https://travis-ci.org/benbalter/github_records_archiver) [](http://badge.fury.io/rb/github_records_archiver) [](https://coveralls.io/github/benbalter/github_records_archiver) [](http://makeapullrequest.com)
Backs up a GitHub organization's repositories and all their associated information for archival purposes.
## What it archives
* Git data (change history, tags, branches, etc.)
* Wikis (including change history)
* Issues and pull request (including comments, current state, etc.)
* Teams (including members and repository permissions)
## Requirements
1. Ruby
2. A GitHub [personal access token](https://github.com/settings/tokens/new) with `repo` scope.
## Setup
If you have Ruby installed, simply run:
```shell
gem install github_records_archiver
```
## Basic usage
```shell
$ github-records-archiver archive ORGANIZATION --token PERSONAL_ACCESS_TOKEN`
```
Alternatively, you could pass the personal access token as the `GITHUB_TOKEN` environmental variable:
```shell
$ GITHUB_TOKEN=1234 github-records-archiver archive ORGANIZATION`
```
## Output
The script will create an `archive` directory, with one folder for each organization.
Within each organization folder, there will be one folder per repository.
Within each repository folder will be the repository content as a git repository.
If the repository has a Wiki, the wiki will be cloned as a `wiki` subfolder, as a Git repository.
If the repository has issues or pull requests, it will create an `issues` sub-folder with each issue and its associated comments stored as both markdown (human readable) and JSON (machine readable).
Example output:
```
├─ archive
├─── organization
├──── repository
├────── README.md
├────── LICENSE.txt
├──── wiki
├────── wiki-page.md
├──── issues
├────── 1.md
├────── 1.json
├─── another organization
├──── another-repository
├────── README.md
├────── LICENSE.txt
├──── wiki
├────── wiki-page.md
├──── issues
├────── 1.md
├────── 1.json
```
## Advanced usage
You may set the following flags:
* `--dest-dir` - the destination archive directory, defaults to `./archive`
* `--verbose` - verbose output while archiving
Additionally, the following commands are also available:
* `delete [ORGANIZATION]` - delete the entire archive directory or an organization's archive
* `help` - display help information
* `version` - display the GitHub Record Archiver version