github-copywriter

Build Status Gem Version

test-repo demo

See the example commit here. See the pretty website here.

Wanna see something a little more... complex?

Updates your copyrights... so you don't have to!

$ gem install github-copywriter

Basic Usage

Update specific repos

$ github-copywriter MyCoolRepo MyOtherCoolRepo

Update all repos

$ github-copywriter --all

More Usage

Update all repos, excluding forks

$ github-copywriter --all --skip-forks

Update all repos to 2015

$ github-copywriter --all --year 2015

Update only branches: gh-pages and dev

$ github-copywriter --branches gh-pages,dev MyRepo

Contributing

Please submit issues or feature requests here. Questions and comments are welcome as well. Checkout CONTRIBUTING.md for more info.

Feel free to fork this project, and:

  • fix bugs
  • add some sweet features
  • implement feature requests
  • improve the docs and/or this site

Under the hood

All GitHub API calls are made with Octokit.

Basic breakdown of the program's logic:

  1. Authenticate to GitHub.
  2. Loop through each user repo given, and:
    • Update copyrights on files: README.md, LICENSE, etc.
    • Create a local commit and push to GitHub.