diff options
author | Jonathan "Duke" Leto <jonathan@leto.net> | 2011-04-28 12:04:48 -0700 |
---|---|---|
committer | Jonathan "Duke" Leto <jonathan@leto.net> | 2011-04-28 12:04:48 -0700 |
commit | 2d8ded73a3ac395839ce4abe0ec59dabfdfba0bf (patch) | |
tree | 98402ccc9cc8db654a942ef27b20c844bf0232d8 /README.md | |
parent | Add on_failure_to_email and on_pass_to_email config keys (diff) | |
parent | Prevent a use of uninitialized value warning (diff) | |
download | jitterbug-2d8ded73a3ac395839ce4abe0ec59dabfdfba0bf.tar.gz |
Merge branch 'reuse_repo'
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c42076a --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +## 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 + + # You can also use Makefile.PL, but you will then have to manually + perl Build.PL + # perl Makefile.PL + + # install missing dependencies + ./Build installdeps + + # you can also use cpanm + # cpanm --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 periodically for a new task and build and test your +projects! + |