Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Latest commit

 

History

History
52 lines (35 loc) · 1.79 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.79 KB

backup-github

Utility tool to backup github repository issues. It will backup all repositories from a given github account. The backup comprises the git repostory, the wiki and the issues.

It works with a local git repository, on which issues from all repositories of a github account are serialized to json and commited. Thanks to git, all changes are versioned, and saved.

To install you can just download the gem with:

    gem install backup-github

Then, to run the backup command:

    backup-github -r path/to/my/backup/dir -u github_user -p github_pwd

If, instead you want to backup up all the issues from an Organization within github, then you run:

    backup-github -r path/to/my/backup/dir -u github_user -p github_pwd -o org_name

Important: The github user used, should have access to all the organization repositories.

To properly configure the backup system, we recommend setting a cron job to run the command once a day.

Dependencies

Besides the gem dependencies, the git binary is required.

Contributing to backup-github

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Zauber. See LICENSE.txt for further details.