Permalink
Browse files

Documents 👍

  • Loading branch information...
1 parent 5433a2b commit 86a41da1b84971d5c68424886e6be2ae323ec833 James Socol committed Jun 3, 2011
Showing with 59 additions and 0 deletions.
  1. +28 −0 LICENSE
  2. +22 −0 README.rst
  3. +9 −0 TODO.rst
View
28 LICENSE
@@ -0,0 +1,28 @@
+Copyright (c) 2011, James Socol
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of jig nor the names of its contributors may
+ be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
View
@@ -0,0 +1,22 @@
+===
+jig
+===
+
+Github has an post-commit hooks for both IRC and HTTP, so why on earth would I
+write another one?
+
+# Github's hooks cannot be filtered by branch. e.g., if I only want pushes to
+ ``master`` to trigger builds in CI, I'm SOL there. (Jenkins/Hudson doesn't do
+ this either: any branch will trigger the build, even if the branch built
+ didn't change.)
+
+# Jenkins really wants you to make GET requests to trigger builds, and Github
+ (correctly) wants to make POSTs.
+
+So **jig** is my little tool to run an HTTP server, accept Github's
+post-receive data, *filter by branch*, push the relevant info to IRC, then
+trigger a build in Jenkins.
+
+In the spirit of open-source, and because other people may find it useful, I'm
+sharing jig here. I'd like to expand on what sort of project reporting it does
+in the future, too.
View
@@ -0,0 +1,9 @@
+====
+TODO
+====
+
+* Finish the README.
+* Make sure config files work at all.
+* Add example configs.
+* Create a config-or-default function and use it.
+* Add ``botsnack`` to check bot health.

0 comments on commit 86a41da

Please sign in to comment.