The github-backup package

[Tags:gpl, program]

github-backup is a simple tool you run in a git repository you cloned from Github. It backs up everything Github knows about the repository, including other forks, issues, comments, milestones, pull requests, and watchers.


[Skip to Readme]

Properties

Versions 1.20120126, 1.20120131, 1.20120313, 1.20120314, 1.20120627, 1.20130414, 1.20131006, 1.20131101, 1.20131203, 1.20140707, 1.20140720, 1.20140721, 1.20141031, 1.20141110, 1.20141204, 1.20141222, 1.20150106, 1.20150617, 1.20150618, 1.20150807, 1.20160207, 1.20160319, 1.20160511, 1.20160522
Dependencies base (<5), bytestring, containers, directory, extensible-exceptions, filepath, github, hslogger, IfElse, MissingH, mtl, network, pretty-show, unix [details]
License GPL
Copyright 2012 Joey Hess
Author Joey Hess
Maintainer Joey Hess <joey@kitenet.net>
Stability Stable
Category Utility
Home page https://github.com/joeyh/github-backup
Source repository head: git clone git://github.com/joeyh/github-backup.git
Uploaded Thu Jan 26 04:22:38 UTC 2012 by JoeyHess
Distributions Debian:1.20160207, LTSHaskell:1.20160522, NixOS:1.20160522
Downloads 3761 total (71 in the last 30 days)
Votes
0 []
Status Docs not available [build log]
All reported builds failed as of 2015-11-19 [all 4 reports]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for github-backup

Readme for github-backup-1.20120126

github-backup is a simple tool you run in a git repository you cloned from Github. It backs up everything Github knows about the repository, including other forks, issues, comments, milestones, pull requests, and watchers.

Installation

git clone git://github.com/joeyh/github-backup cd github-backup make ./github-backup

Or use cabal:

cabal install github-backup --bindir=$HOME/bin

Why backup Github

There are a couple of reasons to want to back this stuff up:

  • In case something happens to Github. More generally because keeping your data in the cloud and relying on the cloud to back it up is foolish.

  • So you can keep working on your repository while on a plane, or on a remote beach or mountiaintop. Just like Linus intended.

What to expect

Each time you run github-backup, it will find any new forks of your project on github. It will add remotes to your repository for the forks, using names like github_linus_divemonitor. It will fetch from every fork.

Then the next pass will download metadata from each fork. This is stored into a branch named "github". Each fork gets a directory in there, like linus_divemonitor. Inside the directory there will be some files, like linus_divemonitor/watchers. There maybe be further directories, like for comments: linus_divemonitor/comments/1.

You can follow the commits to the github branch to see what information changed on github over time.

The format of the files in the github branch is currently Haskell serialized data types. This is plain text, and readable, if you squint.

Limitations

github-backup is repository-focused. It does not try to back up other information from Github. In particular, social network stuff, like users who are following you, is not backed up.

github-backup will find and backup all forks of a repository, and all forks of those forks, etc. However, it cannot go up the fork tree. So if your Github repositoriy is a fork of something else, the something else won't be backed up. There is an easy solution though. Just add the parent as a git remote. Then github-backup will find it, and back it up.

Currently, github-backup re-downloads all issues, comments, and so on each time it's run. This may be slow if your repo has a lot of them.

Author

github-backup was written by Joey Hess joey@kitenet.net

It is made possible thanks to: