Maunsell lab fork of MonkeyWorks Suite Build Infrastructure
Python Shell
Switch branches/tags
Nothing to show
Pull request Compare This branch is 5 commits ahead of mworks-project:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
archiver
bootstrap
buildbot
installer
new_installer
simple_build_script
supporting_libs
uninstaller
xcode_config
.gitignore
README.markdown
build_mworks
fix_group_permissions.py

README.markdown

MW Build Infrastructure

The mw_build repository contains tools to ease the process of building the full MonkeyWorks application suite, which consists of three applications, two frameworks, a flotilla of third-party supporting libraries, and a gaggle of plugins. It also contains tools to make it easier to checkout everything, if you want to play with the code yourself.

The repository is organized into the following subsections:

bootstrap

This directory contains bootstrap.py, which allows you to clone or pull all of the repositories contained in the MW project. If you download or clone just this repository, you can easily bootstrap everything else with one command.

To clone all projects, type: ./bootstrap.py clone

To pull from all projects (assuming you've already cloned): ./bootstrap.py pull

The script, by default, puts everything in the following directory: ~/Repositories/monkeyworks/* If you'd like to put stuff somewhere else, the script is easily edited.

simple_build

Simple build contains a python script for building MW that is, well, simple. This isn't intended as a formal automated build mechanism; rather, it is an easy, low-investment way to do a one-off build of a collection of projects in MW. You may need to edit the project list to suit your needs.

buildbot_master & buildbot_slave

NOTE: if you are a casual user of MW, you do not need to concern yourself with buildbots. You do not need a buildbot to look at the code, or even to build isolated portions of the project (e.g. building a plugin, or editing one of the GUI apps); as long as you have access to an installer, you can install (with the "Developer" option checked in the "Customize" screen) and then build whatever sub-portions you like. You can also use the "simple" build script (below) as a template for doing a basic automated build.

These directories contain the necessary parts to run the MW buildbot setup. Buildbot is an automated build system that coordinates the building of complicated projects like MW. When installed properly, it automatically builds and tests MW every night, and will also build after new commits are made, to ensure that things haven't been broken by an error in a given commit. For more info on BuildBot, see this site.

The Cox Lab maintains a public build master for MW here. If you'd like to setup a build slave, please contact monkeyworks@coxlab.org.

You need both a build "master" and at least one build "slave" to build the projects. These are typically meant to run on separate machines, with the "master" being on a publicly available web server, and one or more slaves doing the actual heavy lifting. To start a build master, you just need to run buildbot_master/start_buildbot_master.sh Likewise for the slave, you'd run buildbot_slave/start_buildbot_slave.sh This file first checks to see if a build master is running, so it is suitable to put in a crontab to keep the build master alive

If you get complaints about there being no command called "buildbot", you just need to install it by running: sudo easy_install buildbot

To stop any running buildbots on your machine: buildbot_master/stop_all_buildbot.sh

To start a local (e.g. running on localhost) buildbot pair (e.g. for testing), run: buildbot_master/start_all_buildbot_local.sh

The buildbot master server will then be running at http://localhost:7349. You can examine build progress, manually kickstart builds, and more.

If you want to run your own buildbot server / slave setup, you'll need to edit the following files: buildbot_slave/start_buildbot_slave.sh buildbot_master/master.cfg To contain appropriate ports and passwords.

installer

The scripts in this directory handle the automatic building of the MW installer. To build an installer, simply run:

./build_installer_package.py <INSTALLER_BASE_NAME> <VERSION_STRING>

The resulting installer will be saved to: /tmp/mw_installer/<INSTALLER_BASE_NAME>_<VERSION_STRING>

archiver

The archiver directory contains a single script, archive.py, that will backup a currently installed MW installation (including old-style out-of-date directories no longer in use by MW). The objective here is allow one to safely preserve a working state before trying out a new installation of MW.

uninstaller

The uninstaller script eradicates all traces of MW on the current system. Note, that it only touches directories currently in use by MW. It will not remove files in unused, deprecated locations.