From e57d371b93f2e46a06ea592b2dcef2b5063cf92e Mon Sep 17 00:00:00 2001 From: tekkub Date: Fri, 16 Oct 2009 20:44:29 -0600 Subject: Add post-receive hook guide --- _posts/2009-10-16-post-receive-hooks.textile | 34 ++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 _posts/2009-10-16-post-receive-hooks.textile (limited to '_posts') diff --git a/_posts/2009-10-16-post-receive-hooks.textile b/_posts/2009-10-16-post-receive-hooks.textile new file mode 100644 index 0000000..ae27cfc --- /dev/null +++ b/_posts/2009-10-16-post-receive-hooks.textile @@ -0,0 +1,34 @@ +--- +layout: default +title: Post-Receive Hooks +description: Working with GitHub's post-receive web hooks. +categories: collaborating +--- + +If you supply a post-receive URL, GitHub will POST to that URL when someone uses git push on that repository. + + + +What we'll send is JSON containing information about the push and the commits involved. + +Here's the template we use in Ruby to generate the JSON: + + + +This is sent as a POST with a single parameter: 'payload' + +So, for example, you'd do something like this in a Sinatra server: + + + +A template Rack server for the task: "raggi/github_post_receive_server":http://github.com/raggi/github_post_receive_server/ + +Send something to "Campfire":http://github.com/jnewland/github-campfire/, "IRC":http://github.com/webs/irccat, "Twitter":http://github.com/jnunemaker/github-twitter/, your CI server, whatever. It's your data. + +The @commits@ array is ordered with the most recent commit as the first element. The last element, therefor, is the oldest commit. + +Here's an example of a POST'd 'payload' JSON object: + + + +For more information on this technique, see the Web Hooks Wiki. \ No newline at end of file -- cgit v1.3.1