0.0
No commit activity in last 3 years
No release in over 3 years
Find forks of a GitHub project that are ahead of the base
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 1.0.2
 Project Readme

forks_ahead

A lot of people fork my GitHub repositories, but not many people make any changes. This tool takes the owner and name of a repository, and finds all branches of forks that are ahead of the original repository.

Installation

In a terminal, run

gem install forks_ahead

Usage

In a terminal, run

forks_ahead <owner> <repo>

Where <owner> is the owner of the base repository and <repo> is the name of the base repository.

Authentication

GitHub's anonymous rate limits probably won't be enough for this tool to work correctly on a repository of any popularity, so you will probably need to authenticate with GitHub.

Token Authentication

Create an OAuth token with repo permissions (private_repo is required to access private repositories), and set it as the FORKS_AHEAD_GITHUB_TOKEN. This is the preferred way of authenticating.

Basic Authentication

Set your GitHub login as the FORKS_AHEAD_GITHUB_LOGIN environment variable and your GitHub password as FORKS_AHEAD_GITHUB_PASSWORD.

This will not work if you have two-factor authentication enabled on your GitHub account.

Sample

$ forks_ahead rubycocoa rubycocoa
Watson1978/rubycocoa:rbenv ahead of rubycocoa:master by 1
alloy/rubycocoa:cocoapods-app ahead of rubycocoa:master by 8
alloy/rubycocoa:cocoapods-app-with-swift ahead of rubycocoa:master by 8

Development

After checking out the repo, run bundle to install dependencies.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in forks_ahead.gemspec, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alyssais/forks_ahead. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.