Permalink
Browse files

Update some docs.

  • Loading branch information...
1 parent ac79db4 commit 258440c978f44bf775d9a1598c2082f8de577ef5 James Socol committed Oct 25, 2011
Showing with 83 additions and 4 deletions.
  1. +11 −0 CHANGELOG.rst
  2. +65 −0 INSTALL.rst
  3. +1 −1 LICENSE
  4. +6 −3 README.rst
View
@@ -0,0 +1,11 @@
+=========
+CHANGELOG
+=========
+
+
+v0.2.0
+======
+
+* Fixed up configuration. Now works correctly.
+* Posts info about pull requests into IRC channels. (Try "pull 3".)
+* Responds to ``botsnack`` for health checks.
View
@@ -0,0 +1,65 @@
+==============
+Installing Jig
+==============
+
+Installing Jig is *mostly* very simple, with one temporary complication.
+
+
+Installation
+============
+
+First you'll want to clone the repo, or otherwise get the source::
+
+ $ git clone https://github.com/jsocol/jig
+ $ cd jig
+
+Run ``npm install .`` to pull in the dependencies::
+
+ $ npm install .
+
+Now here's the tricky bit: until a pull request gets merged, you need to use my
+fork of node-github_, which implements part of the API that isn't in the main
+repo yet.
+
+This is what I did, you can probably do better::
+
+ $ cd node_modules
+ $ mv github/node_modules ./
+ $ rm -rf github
+ $ git clone https://github.com/jsocol/node-github github
+ $ mv node_modules github/
+ $ cd ..
+
+That should do it!
+
+Once that pull-req_ gets merged, things will be much simpler.
+
+
+Configuring
+===========
+
+Before you can run Jig, you'll need to configure it. I know, it stinks. But
+there were too many options for pure CLI config.
+
+Copy ``example.config.ini``, maybe to ``config.ini``, and edit it. There are
+comments inline to help.
+
+
+Running
+=======
+
+Ah, the easy part! Once you have a ``config.ini`` file::
+
+ $ node jig.js
+
+If your config file isn't called ``config.ini`` or is in another location, you
+can do::
+
+ $ node jig.js --config=/path/to/config/file.ini
+
+I recommend setting it up to run with supervisor, or configuring Jig to
+daemonize itself. Running in a detached screen session works, too.
+
+
+.. _node-github: https://github.com/jsocol/node-github
+.. _pull-req: https://github.com/ajaxorg/node-github/pull/20
View
@@ -11,7 +11,7 @@ are permitted provided that the following conditions are met:
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
+ 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.
View
@@ -1,5 +1,5 @@
===
-jig
+Jig
===
Github has an post-commit hooks for both IRC and HTTP, so why on earth would I
@@ -13,10 +13,13 @@ write another one?
2. 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
+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
+sharing Jig here. I'd like to expand on what sort of project reporting it does
in the future, too.
+
+Jig is designed to support one repo per instance. You probably don't want to
+send post-commit hooks from multiple repos to it.

0 comments on commit 258440c

Please sign in to comment.