Skip to content

chrismytton/rack-github_webhooks

Repository files navigation

Rack::GithubWebhooks Build Status

Rack middleware for validating GitHub webhooks.

Installation

Add this line to your application's Gemfile:

gem 'rack-github_webhooks'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-github_webhooks

Usage

Use it in your config.ru file, in your Sinatra app or in Rails' config/routes.rb file as you would any other Rack middleware. You need to provide a secret option which is the webhook secret you supplied when creating your GitHub webhook.

require 'rack/github_webhooks'

use Rack::GithubWebhooks, secret: 's3cret'

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chrismytton/rack-github_webhooks.

License

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

About

Rack middleware for validating GitHub webhooks

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •