@@ -1,3 +1,5 @@ pkg/* NOTES test/__workdir +doc/site/out +doc/site/webgen.cache .gitignore @@ -7,9 +7,9 @@ sort_info: 6 The following people made notable contributions to the Cerberus tool: -* "Anatol Pomozov":http://pomozov.info - original creator of Cerberus tool +* [Anatol Pomozov](http://pomozov.info) - original creator of Cerberus tool * Xavier Shay - several patches related to RSS publisher * Mark Noworolski - patches related to Subversion SCM -* Rob Kaufman - Git SCM support -* Craig Jolicoeur - Twitter publisher support +* [Rob Kaufman](http://notch8.com) - Git SCM support +* [Craig Jolicoeur](http://craigjolicoeur.com) - Twitter publisher support * Ken Mayer - patches related to properly checking shell command exitstatus doc/site/src/credits.page @@ -7,7 +7,7 @@ sort_info: 2 ### Why Cerberus uses an external scheduler and not internal one like CruiseControl? -Cerberus was developed as a __stateless__ continuous building tool. +Cerberus was developed as a _stateless_ continuous building tool. In this context it means that Cerberus won't consume RAM all the time. For example, CruiseControl requires about 120 Megabites of RAM even if it has @@ -25,8 +25,8 @@ It is a really smart and nifty technique. ### How to change task(s) for Rake -__Q: In my project we need to run Rails migrations before tests. But by default Cerberus runs the :default task. -How could I run eg. migrations?__ +_Q: In my project we need to run Rails migrations before tests. But by default Cerberus runs the :default task. +How could I run eg. migrations?_ It is easy - just setup rake task option in config: <pre> @@ -35,16 +35,16 @@ builder: task: db:migrate test </pre> -given configuration above, rake would run first migrations and then tests. You could set __task__ option +given configuration above, rake would run first migrations and then tests. You could set _task_ option to any other combination of Rake tasks. ### How to schedule Cerberus build on nnCron -"nnCron":http://www.nncron.ru/download/nncron191.exe is a scheduling tool for Windows. It is a good replacement for Unix Cron +[nnCron](http://www.nncron.ru/download/nncron191.exe) is a scheduling tool for Windows. It is a good replacement for Unix Cron on the Windows platform. nnCron has simple user interface and it is easy to add new scheduled tasks. -There is only one issue - nnCron doesn't pass __HOME__ environment variable to process, so you need to add it to nncron.tab file. -You could add __CERBERUS\_HOME__ environment variable or __HOME__ (in the last case __CERBERUS\_HOME__ would evaluate to +There is only one issue - nnCron doesn't pass _HOME_ environment variable to process, so you need to add it to nncron.tab file. +You could add _CERBERUS\_HOME_ environment variable or _HOME_ (in the last case _CERBERUS\_HOME_ would evaluate to HOME/.cerberus) My nncron.tab file looks as follows: @@ -62,9 +62,9 @@ START-APPW: c:\progra~1\ruby\bin\cerberus.CMD buildall )# </pre> -h3. Running Cerberus from Subversion __post-commit__ hook +### Running Cerberus from Subversion _post-commit_ hook -Subversion as well as other SCMs allow you to "hook actions on commit":http://svnbook.red-bean.com/en/1.1/ch05s02.html#svn-ch-5-sect-2.1. +Subversion as well as other SCMs allow you to [hook actions on commit](http://svnbook.red-bean.com/en/1.1/ch05s02.html#svn-ch-5-sect-2.1). If you install Cerberus on the same system where you keep your Subversion repository, you could add a custom hook to run CI tool right after the user commit. In this case you don't need to use cron or any other scheduling system. @@ -72,7 +72,7 @@ Next follows a short guide how to do it, in fact, it is very simple. First you need to copy SUBVERSION_REPO/hooks/post-commit.tmpl to SUBVERSION_REPO/hooks/post-commit and make it executable for *user who would manage the repository*. For example, on Ubuntu Linux with subversion repository served by Apache (through mod_svn) -hooks are run as user __www-data__ so change the ownership of post-commit to www-data: +hooks are run as user _www-data_ so change the ownership of post-commit to www-data: <pre> sudo chown www-data:www-data SUBVERSION_REPO/hooks/post-commit @@ -84,7 +84,7 @@ Then add the following content to SUBVERSION\_REPO/hooks/post-commit: <pre> #!/bin/sh -/usr/bin/env cerberus build YOUR_APPLICATION_NAME & +/usr/bin/env cerberus build YOUR_APPLICATION_NAME &amp; </pre> To test correctness of the hook, just run @@ -98,16 +98,16 @@ If you have any problems with permissions (for example CERBERUS\_HOME not writab If command finished successfully, you should have a file in CERBERUS_HOME/work/YOUR_APPLICATION\_NAME/logs. -h3. I would like to disable (but not remove) a project in Cerberus +### I would like to disable (but not remove) a project in Cerberus -Sometimes we need to temporarily disable an application and not allow __cerberus buildall__ command to build it. +Sometimes we need to temporarily disable an application and not allow _cerberus buildall_ command to build it. To achieve this, just rename configuration file for YOUR_APPLICATION from -__config/YOUR_APPLICATION.yml__ to eg. __config/YOUR\_APPLICATION.yml.disabled__ +_config/YOUR_APPLICATION.yml_ to eg. _config/YOUR\_APPLICATION.yml.disabled_ Cerberus picks up only configurations that end with .yml -h3. Cerberus hangs on updating password-protected repository +### Cerberus hangs on updating password-protected repository When subversion tries to update password-protected repository, it prompts for user to enter appropriate credentials. Cerberus cannot interact with subversion client in an interactive way, making subversion to wait for password infinitely. @@ -124,7 +124,7 @@ Another and even better option would be to create a ssh key pair in repository a copy resulting private key to the same host cerberus is running and configure your ssh client to use it. -h3. I have added Cerberus job to Cron but it does not work for me. It doesn't even start to build. +### I have added Cerberus job to Cron but it does not work for me. It doesn't even start to build. It seems that you configured Cron incorrectly. @@ -140,15 +140,15 @@ This works for me. But if you get some strange errors, the following trick might For more info please read Cron manual: <pre>man crontab</pre> -h3. How to change location of Cerberus directory +### How to change location of Cerberus directory By default cerberus creates its own files in user's home directoy. But you could change it by setting the environment variable -__CERBERUS\_HOME__: +_CERBERUS\_HOME_: <pre> export CERBERUS\_HOME=/var/cerberus </pre> -h3. How to add Darcs project to Cerberus +### How to add Darcs project to Cerberus If you want to add Darcs (or other custom SCM) project to cerberus, you should explicitly tell that to cerberus. <pre>cerberus add PROJECT_DIR SCM=darcs</pre> doc/site/src/faq.page @@ -7,9 +7,9 @@ sort_info: 5 Below is a list of articles related to Cerberus. -* Legendary "article about Continuous Integration":http://www.martinfowler.com/articles/continuousIntegration.html by Martin Fowler -* Very interesting reading about automated builds "Daily Builds Are Your Friend":http://www.joelonsoftware.com/articles/fog0000000023.html by Joel Spolsky -* "Theory of Broken Windows":http://en.wikipedia.org/wiki/Fixing_Broken_Windows explanation. This theory says that big problems start from small ones. And if you are able to quickly and effectively solve small ones (like broken windows) you'll avoid most of the big problems (like crime). -* Very good "Cerberus tutorial":http://www.degrunt.net/articles/2006/08/27/cerberus-continious-integration-for-rails/#extended from Tom de Grunt -* "Josh's article":http://www.cuberick.com/?p=43 -* "Yurii Rashkovskii's great intro article about Cerberus setup":http://rashkovskii.com/articles/2007/1/10/continuous-integration-cerberus +* Legendary [article about Continuous Integration](http://www.martinfowler.com/articles/continuousIntegration.html) by Martin Fowler +* Very interesting reading about automated builds [Daily Builds Are Your Friend](http://www.joelonsoftware.com/articles/fog0000000023.html) by Joel Spolsky +* [Theory of Broken Windows](http://en.wikipedia.org/wiki/Fixing_Broken_Windows) explanation. This theory says that big problems start from small ones. And if you are able to quickly and effectively solve small ones (like broken windows) you'll avoid most of the big problems (like crime). +* Very good [Cerberus tutorial](http://www.degrunt.net/articles/2006/08/27/cerberus-continious-integration-for-rails/#extended) from Tom de Grunt +* [Josh's article](http://www.cuberick.com/?p=43) +* [Yurii Rashkovskii's great intro article about Cerberus setup](http://rashkovskii.com/articles/2007/1/10/continuous-integration-cerberus) doc/site/src/in_the_web.page @@ -7,28 +7,28 @@ sort_info: 1 Cerberus is a lightweight and easy-to-use Continuous Builder software for Ruby. It could be run periodically from a scheduler and check if application tests are broken. In case of failed tests Cerberus sends notification to developers. -Cerberus works perfectly both on Windows and \*nix platforms and supports popular version control systems like Subversion, Darcs and Perforce. It also has many ways in publishing build results such as e-mail, jabber, "Campfire":http://www.campfirenow.com, IRC and RSS files. +Cerberus works perfectly both on Windows and \*nix platforms and supports popular version control systems like Subversion, Git, Darcs and Perforce. It also has many ways in publishing build results such as e-mail, jabber, [Twitter](http://twitter.com), [Campfire](http://www.campfirenow.com), IRC and RSS files. Cerberus requires: -* "ruby":http://ruby-lang.org/en/ - 1.8.2 or higher -* "rake":http://rubyforge.org/projects/rake - 0.7 or higher -* "subversion":http://subversion.tigris.org/ client - 1.2 or higher (optional) -* "darcs":http://darcs.net/ client - 1.0.7 or higher (optional) -* "bjam":http://www.boost.org/tools/build/v2/index.html (optional) -* "perforce":http://www.perforce.com/ (optional) -* "git":http://git.or.cz (optional) +* [ruby](http://ruby-lang.org/en/) - 1.8.2 or higher +* [rake](http://rubyforge.org/projects/rake) - 0.7 or higher +* [subversion](http://subversion.tigris.org/) client - 1.2 or higher (optional) +* [darcs](http://darcs.net/) client - 1.0.7 or higher (optional) +* [bjam](http://www.boost.org/tools/build/v2/index.html) (optional) +* [perforce](http://www.perforce.com/) (optional) +* [git](http://git.or.cz) (optional) #### What does 'Cerberus' name mean? -Quote from "Wikipedia":http://en.wikipedia.org/wiki/Cerberus -bq. Cerberus or Kerberos (Kerberos, demon of the pit), was the hound of Hades-a monstrous three-headed dog with a snake for a tail and innumerable snake heads on his back. -He guarded the gate to Hades (the Greek underworld) and ensured that the dead could not leave and the living could not enter. His brother was Orthrus. He is the offspring of Echidna and Typhon. +Quote from [Wikipedia](http://en.wikipedia.org/wiki/Cerberus) +> Cerberus or Kerberos (Kerberos, demon of the pit), was the hound of Hades-a monstrous three-headed dog with a snake for a tail and innumerable snake heads on his back. +> He guarded the gate to Hades (the Greek underworld) and ensured that the dead could not leave and the living could not enter. His brother was Orthrus. He is the offspring of Echidna and Typhon. -!images/cerberus.gif! + So Ruby Cerberus tool (like his ancestor) will guard your application tests and won't let your project go to the world of dead projects. -h4. There are several solutions already present, why do you need to use Cerberus? +#### There are several solutions already present, why do you need to use Cerberus? Main advantages of Cerberus over other solutions: * Cerberus could be installed on any machine, not only where SVN repository is located. @@ -41,19 +41,17 @@ Main advantages of Cerberus over other solutions: It is very easy to use Cerberus. First install it. Using RubyGems package manager is the easiest way to do it. -gem install cerberus --include-dependencies -{: .code} +<pre>gem install cerberus --include-dependencies</pre> -or just get Cerberus distribution package right from "the download page":http://rubyforge.org/frs/?group_id=1794&release_id=6442 +or just get Cerberus distribution package right from [the download page](http://rubyforge.org/frs/?group_id=1794&release_id=6442) Then you need to add project which will be watched by Cerberus. Do it by -cerberus add (DIR|SVN_URL) APPLICATION\_NAME=some_app RECIPIENTS=dev1@project.com -{: .code} +<pre>cerberus add (DIR|SVN_URL) APPLICATION\_NAME=some_app RECIPIENTS=dev1@project.com</pre> as a second parameter you could pass URL to subversion repository or directory with working SVN folder. -Go to ~/.cerberus and edit config.yml file (only once after installing Cerberus). Enter your configuration options here like email server, password, user\_name and other options. See "ActiveMailer":http://api.rubyonrails.com/classes/ActionMailer/Base.html description for more - Cerberus uses it as default notification layer. +Go to ~/.cerberus and edit config.yml file (only once after installing Cerberus). Enter your configuration options here like email server, password, user\_name and other options. See [ActiveMailer](http://api.rubyonrails.com/classes/ActionMailer/Base.html) description for more - Cerberus uses it as default notification layer. Here is an example of configuration file @@ -72,13 +70,11 @@ Also check ~/.cerberus/config/&lt;APPLICATION\_NAME&gt;.yml and make sure your o Then run Cerberus for the project: -cerberus build APPLICATION\_NAME -{: .code} +<pre>cerberus build APPLICATION\_NAME</pre> or build __all__ registered projects: -cerberus buildall -{: .code} +<pre>cerberus buildall</pre> Cerberus will check out latest sources and run tests for your application. If tests are broken, recipients will receive notifications. @@ -86,4 +82,4 @@ But of course it is better to run Cerberus automatically i.e. from Cron, say, ev Also, if you have the option of installing your own software where the Subversion server is located then it is better to run cerberus from Subversion hook. In this case Cerberus would run right after commit without any delays! -Now you can see that to setup Cerberus is a very easy thing to do - no need for long manuals and costly training, no consultants whatsoever or weeks of setting up the software. Cerberus - Just Use It!(C) +Now you can see that to setup Cerberus is a very easy thing to do - no need for long manuals and costly training, no consultants whatsoever or weeks of setting up the software. Cerberus - Just Use It!&copy; doc/site/src/index.page @@ -69,6 +69,7 @@ hook: HOOK_NAME: on_event: action: +</pre> #### Options available in command line doc/site/src/options.page @@ -5,7 +5,7 @@ sort_info: 3 --- ## Who uses -#### [Anatol Pomozov]: http://blog.pomozov.info/tags/english/ +#### [Anatol Pomozov](http://blog.pomozov.info/tags/english/) After using "Ruby On Rails":http://rubyonrails.com framework for a while in my day-job I became test-infected developer. RoR allows you to create tests for your application with exciting simplicity so it is hard not to be test-infected. @@ -26,7 +26,7 @@ Now I am using Cerberus for my 8 Ruby projects and happy with it. I have schedul run each 15 minutes and if tests for any of my project are broken Cerberus would notify me about that. -#### [Abonja]: http://www.abonja.nl +#### [Abonja](http://www.abonja.nl) At Abonja we have been using unit-tests and continuous builds for our C++ projects. Next to our C++ work we are now using Ruby on Rails for the doc/site/src/who_uses.page e24a78aff13ccd6481c1a8d9ee24f55bf5d23174 Craig P Jolicoeur cpjolicoeur@gmail.com http://github.com/notch8/cerberus/commit/316a07428a72ecaf057a3588a20e8921f2bb95ad 316a07428a72ecaf057a3588a20e8921f2bb95ad 2008-12-31T06:37:35-08:00 2008-12-31T06:32:26-08:00 updates for new webgen 5.x system 2c7fc2cd80732f73ebb6886661c41a3a5fbf7694 Craig P Jolicoeur cpjolicoeur@gmail.com