Technology moves fast! ⚡ Don't get left behind.🚶 Subscribe to our mailing list to keep up with latest and greatest in open source projects! 🏆


Subscribe to our mailing list

github-records-archiver

Backs up a GitHub organization's repositories and all their associated information for archival purposes.

Subscribe to updates I use github-records-archiver


Statistics on github-records-archiver

Number of watchers on Github 66
Number of open issues 5
Average time to close an issue about 7 hours
Main language Ruby
Average time to merge a PR about 1 hour
Open pull requests 1+
Closed pull requests 1+
Last commit over 3 years ago
Repo Created over 3 years ago
Repo Last Updated about 1 year ago
Size 27 KB
Organization / Authorbenbalter
Contributors2
Page Updated
Do you use github-records-archiver? Leave a review!
View open issues (5)
View github-records-archiver activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating github-records-archiver for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

GitHub Records Archiver

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 with public_repo and repo scope.

Setup

  1. git clone https://github.com/benbalter/github-records-archiver
  2. cd github-records-archiver
  3. gem install bundler
  4. bundle install

Usage

bin/archive [ORGANIZATION]

You'll want to set the following environmental variable:

  • GITHUB_TOKEN - Your personal access token

You may set the following environmental variables:

  • GITHUB_ARCHIVE_DIR to specify the output directory. It will default to ./archive.
  • GITHUB_ORGANIZATION - The organization to archive if none is passed as an argument.

These can be passed as GITHUB_TOKEN=123ABC GITHUB_ORGANIZATION=whitehouse bin/archive.

You can also add the values to a .env file in the project's root directory, which will be automatically set as environmental variables.

Output

The script will create an archive directory, with one folder for each repository.

Within each 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).

github-records-archiver open issues Ask a question     (View All Issues)
  • over 3 years Tests
  • over 3 years Release as a gem
github-records-archiver open pull requests (View All Pulls)
  • Generate timestamp on archive for org
github-records-archiver list of languages used
Other projects in Ruby