With some encouragement from my colleagues, I expanded the original post here to be a more soup-to-nuts recipe for setting up CC.rb with git and xcodebuild on Mac OS X. Thanks, guys!
I am currently working on a cross-platform project which has multiple targets that need to build on Mac OS X. On my previous project, we were using CruiseControl.rb on linux to watch a Subversion repository for a Rails project and run all the associated tests upon checkin. Since we wanted to be like the Cool Kids on this new project, we of course decided to use git for source code management. We use gitosis to manage multiple remote git repositories under a single user. However, you can use any approach you want for the remote repository management as long as you can compose a git URL that points to it.
- You have a Mac that is probably not your development machine that will serve as a Continuous Integration (CI) server.
- You have a remote git repository that the CI machine can monitor and pull changes from.
It took a little doing to make CC.rb play nice on Mac OS X. In addition to the typical CC.rb installation, getting CC.rb to launch at system startup using launchd took the proper file in the proper location. Nevertheless, the whole setup is pretty darned straightforward. Here’s how I did it:
- I created a user named “continuousintegration.” You can name yours anything you like, or use an existing user. Log in as this user.
- Download and install CruiseControl.rb. I unpacked it into the the home directory of the continuousintegration user. So, the absolute path to the CC.rb installation directory in my case is:
- Create the work directory for CC.rb. In my case, I use
/var/cruiseas the work directory. This required admin privileges to create; just make sure that your CI user has access to this directory.
sudo mkdir /var/cruise sudo chown continuousintegration /var/cruise
- Add your git repository to CC.rb.
cd ~/cruisecontrol.rb ./cruise add <project name> --url <git repository url> -s git
- At the root level of your git repository, add a file named
cruise_config.rb. This provides some useful configuration information so that CC.rb knows what to do in order to build your project as well as whom to notify when the build fails. You provide the build command for CC.rb in
cruise_config.rbby assigning to
project.build_command. I actually made my build command point to
./ci_build.shso that I can do anything I want for the build in a separate shell script named
ci_build.shin the git repository root. In my case, I am actually running
xcodebuildto build a target I created in my Xcode project; you can do literally anything you want here, e. g.
make check, rake… whatever! Witness my
ci_build.shfiles. (If you create a
ci_build.shor equivalent file, be sure you make it executable.) Make sure you
git pushyour changes to add the
ci_build.shif you choose to do so).
- You should now be able to start up CC.rb and look at the dashboard to see your project.
Browse to http://localhost:3333
- Wait! You’re not finished yet! There’s one more step: setting up CC.rb to start every time the system starts up. This is accomplished by creating a plist file in
/Library/LaunchDaemonswhich starts up CC.rb. (For more information on what’s going on here, see the Apple documentation or
Download this plist file and copy it into
sudo cp localcruisecontrol.plist.txt /Library/LaunchDaemons/local.cruisecontrol.plist
Now when you restart the CI machine, CC.rb should start up automatically.
Setting up CC.rb all by itself tends to be pretty easy; it’s getting the daemon to run at system startup as well as getting your build to work properly that tend to be the problems. If you’re having trouble getting things running after following these directions, or if you find errors in these directions, please let me know.