- A post-receive background job is submitted when someone pushes their commits to GitHub
- If the repository the commits belong to has any "Service Hooks" setup, the
job makes a request to
http://services-server/service_name/push
with the following data:params[:payload]
containing all of the commit data (the same data you get using the API)params[:data]
containing the service data (username, password, room, etc)
- Sinatra (github-services.rb) processes the request (twitters your data, says something in campfire, posts it to lighthouse, etc)
- Rinse and repeat
-
Fork the project
-
Create a new file in /services/ called
service_name.rb
, using the following template:class Service::ServiceName < Service def receive_push end end
-
Vendor any external gems your code relies on, and make sure it is specified in the Gemfile.
-
Add documentation to
docs/service_name
(refer to the others for guidance) -
Send a pull request from your fork to github/github-services
-
Once it's accepted we'll add any new necessary data fields to the GitHub front-end so people can start using your addition.
Patches including tests are encouraged
A huge thanks goes out to our many contributors!
- [sudo] gem install hpricot
- git clone git://github.com/github/github-services.git
- cd github-services
- ruby github-services.rb
- Bugs in the code should be filed under the Issues tab
- Problems with the service hooks can be filed here
You can test your service in a ruby irb console:
-
Run
rake console
to start irb. -
Instantiate your Service:
svc = Service::MyService.new(:push, # Hash of configuration information. {'token' => 'abc'}, # Hash of payload. {'blah' => 'payload!'}) svc.receive_push
-
The third argument is optional if you just want to use the sample payload.
svc = Service::MyService.new(:push, # Hash of configuration information. {'token' => 'abc'}) svc.receive_push
You can also test your hook with the Sinatra web service:
- Start the github-services Sinatra server with
ruby github-services.rb
. By default, it runs on port 8080. - Edit the docs/github_payload file as necessary to test your service. (Usually just editing the "data" values but leaving the "payload" alone.)
- Send the docs/github_payload file to your service by calling:
./script/deliver_payload [service-name]