From e9dfe8b506608610ad801ee6684b6f34067ee504 Mon Sep 17 00:00:00 2001 From: "Jonathan \"Duke\" Leto" Date: Wed, 27 Apr 2011 22:28:18 +0000 Subject: tell github our readme is markdown --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e3f4d0 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +## Jitterbug : Cross Language Continuous integration for Git + + +### What is Jitterbug? + +Jitterbug is written in Perl 5 and depends on various CPAN modules, such +as Moose, Dancer, DBIx::Class and others. + +### Installing Jitterbug + +perl Build.PL + +# You can also use Makefile.PL, but you will then have to manually +# install dependencies +# perl Makefile.PL + + # install missing dependencies + ./Build installdeps + + # Look at config.yaml or example.yaml for how to configure your Jitterbug instance + $EDITOR config.yaml + + # start the jitterbug Dancer app, which by default binds to port 3000 + perl jitterbug.pl + + # If you need to start it on a different port use -p + perl jitterbug.pl -p 3001 + +In another terminal, deploy a DBIx::Class schema ( which is SQLite by default, +change the values in config.yml to tweak) : + + perl scripts/jitterbug_db --config config.yml --deploy + +Now add a post-receive hook to your github project that hits the /hook/ URL +on the server that the jitterbug Dancer app is running on, i.e. + + http://example.com:3001/hook/ + +Now you must start the builder, which actually clones a new git repo for +each task (this could be network-intensive) and actually runs the build +and test commands for each project. + + perl scripts/builder.pl -c config.yml + +Now, when you commit to a project that has a Jitterbug post-receive hook, +the builder check every 30 seconds for a new task and build and test your +projects! + -- cgit 1.4.1