GitFonky

Time to GitFonky! What do we do here you ask? Well, if you're like us, you have numerous repositories that you work on with others and keeping them all up-to-date can be a real drag. That's where we come in with the funk! We take care of pulling in all the latest code for each repository you tell us by running one command!

Installation

gem install git_fonky

Usage

GitFonky uses two environment variables in order to do its thing - GFONK_DIR and GFONK_REPOS.

GFONK_DIR

Set this environment variable if you wish to override the default directory that GitFonky uses to look for your repositories within. If you do not set this environment variable then the defualt is to use the current users HOME directory and then a directory called /code. This is would be something like /Users/somebody/code done via "#{Dir.home}/code.

If you set the GFONK_DIR environment variable you should set it to the full path to the directory that contains all of the repositories you want to stop faking the funk with.

GFONK_REPOS

This environment variable must be set if you want any funk to happen! The value of this environment variable should be a string of repository names separated only by commas (NO SPACES!):

export GFONK_REPOS="repo1,repo2,repo3"

You can also specify a branch, origin remote and fork remote to use with a given repository. To specify these add a colon after the repository name followed by the name of the branch, origin remote and fork remote.

export GFONK_REPOS="repo1,repo2:main,repo3:staging:origin_remote:fork_remote"

If you do not specify a branch, origin remote or fork remote the following defaults will be used: default branch: main default origin remote: origin default fork remote: fork

Running the fonk

The gem comes with a bin script that is used to kick off the process. To run the script, type the following in your terminal:

gfonk

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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

Contributing

Bug reports and pull requests are welcome on the GitHub page for the gem.

License

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