Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 3.85 KB

README.md

File metadata and controls

111 lines (78 loc) · 3.85 KB
Raw

Lolcommits Uploldz

Build Gem Depfu

lolcommits takes a snapshot with your webcam every time you git commit code, and archives a lolcat style image with it. Git blame has never been so much fun!

This plugin uploads each lolcommit to a remote server after capturing. You configure the plugin by setting a remote endpoint to handle the HTTP post request. The following params will be sent:

  • file - captured lolcommit file
  • message - the commit message
  • repo - repository name e.g. lolcommits/lolcommits
  • sha - commit SHA
  • author_name - the commit author name
  • author_email - the commit author email address
  • key - optional key (string) from plugin config

You can also set an optional HTTP Basic Auth header (username and/or password).

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-uploldz

Then configure to enable and set the remote endpoint:

$ lolcommits --config -p uploldz
# set enabled to `true`
# set the remote endpoint (must begin with http(s)://)
# optionally set a key (sent in params) and/or HTTP Basic Auth credentials

That's it! Provided the endpoint responds correctly, your next lolcommit will be uploaded to it. To disable use:

$ lolcommits --config -p uploldz
# and set enabled to `false`

Development

Check out this repo and run bin/setup, this will install all dependencies and generate docs. Use bundle exec rake to run all tests.

You can also run bin/console for an interactive prompt that will allow you to experiment with the gem code.

Tests

MiniTest is used for testing. Run the test suite with:

$ rake test

Docs

Generate docs for this gem with:

$ rake rdoc

Troubles?

If you think something is broken or missing, please raise a new issue. Take a moment to check it hasn't been raised in the past (and possibly closed).

Contributing

Bug reports and pull requests are welcome on GitHub.

When submitting pull requests, remember to add tests covering any new behaviour, and ensure all tests are passing on Travis CI. Read the contributing guidelines for more details.

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. See here for more details.

License

The gem is available as open source under the terms of LGPL-3.

Links