Skip to content

Creating a Build Manually

childsb edited this page Aug 31, 2012 · 23 revisions

Table of Contents

About this page

This page describes how to run the Maqetta build scripts manually. Developers sometimes need to do manual builds for one-off development/debugging reasons or because they can't wait until the next automatic build. The are automatic builds run at a regular time each day or multiple times per day.

The manual build scripts prepare a release build, doing things such as combining zillions of separate JS and CSS files into a much smaller number of consolidated (but bigger) files and minifying the files. The build scripts also are necessary in leverage HTML5 application cache. The build scripts also do some preparatory work such as automatically injecting the build number into the "About Maqetta" dialog.

As a developer, it is assumed that you have cloned the Maqetta repository and imported all the projects from the repository into Eclipse. You may need to install the EGit Eclipse plugin if you haven't done so already.

Prerequisites

Your machine needs the following to create builds:

  • Java 1.5 or greater 64-bit JVM
  • git version 1.7.*
  • cvs command line

Pre-setup

You'll need the following environment variables set. (I've placed mine in ~/.profile):

Here is where the build takes place. Build results are placed here as well.

  • MAQETTA_BUILD_DIR (export MAQETTA_BUILD_DIR=/Users/childsb/dev/build_output)
This tells the build script to run the separate dojo build
  • MAQETTA_DOJO_BUILD (export MAQETTA_DOJO_BUILD=true)
Verify that git and cvs are available on the command line by typing git and cvs within a terminal

Instructions for Building from Command Line

Here are the instructions for running a manual build. I've included my exact commands as reference

  • Open a shell prompt
  • cd to your maqetta git repo, then to the releng/davinci.releng subfolder. (cd ~/dev/git/maqetta/releng/davinci.releng/)
  • run the build.orion.sh script from the ~/dev/git/maqetta/releng/davinci.releng/ directory (( ./build.orion.sh)
Thats it! Sit back and wait for the build to finish.

Build Validation

  • Once the build has completed (around 1.5 hours sometimes), change to the BUILD_OUTPUT directory as set earlier (cd $MAQETTA_BUILD_DIR)
  • The build work is done within a timestamp directory. Look for a directory that looks like I201208201124, but with a recent timestamp.
  • Change to this timestamped directory ((cd I201208201124)
  • Under the first timestamped directory is another timestamped directory that looks something like this: I20120820-1124. This directory holds the compiled build archives.

Troubleshooting/FAQ

I'm running OSX. Where can I get the cvs command? If you're running OSX older than Lion, you can get the command line cvs by installing the Xcode from the OSX installation CD. If you're running Lion, then you need either a 3rd party cvs utility, or i've hacked it in by manually installing the older xcode packages (if you run the top level xcode installer it will say its not valid for the current operating system. you have to drill down into the sub directories until you find individual packages)

Changes i've commited aren't showing up in the build You may need to erase your build directory and re-run the build

Every time i clear the build directory, the build takes twice as long! When you delete everything in your build directory, skip the support sub directory. It contains a large base builder which doesn't change. The shell script retrieves the base builder from cvs ((hence the need for cvs command)). if it already exists, the fetch is skipped.

Clone this wiki locally