Changes between Version 1 and Version 2 of Build Recipes

Timestamp:

Jun 6, 2005, 3:48:12 PM (19 years ago)

Author:

cmlenz

Comment:

Draft of the recipe file format

Build Recipes

@@ -6 +6 @@
 
 A recipe can and should split the build into multiple separate steps so that the build slave can provide better status reporting to the build master while the build is still in progress. This is important for builds that might take long to execute. In addition, build steps help organize the build results for a more structured presentation.
+
+== File Format ==
+
+Build recipes are written in a custom XML-based format. Recipe files have a single {{{<recipe>}}} root element with one or more {{{<step>}}} child elements. The steps are executed in the order they appear in the recipe. A {{{<step>}}} element will consist of any number of commands and reports. These elements are declared in XML namespaces, where the namespace URL is a pseudo-protocol that defines which Python module they are implemented in:
+{{{
+#!xml
+<?xml version="1.0"?>
+<recipe description="My project"
+    xmlns:python="bitten:bitten.recipe.pythontools">
+
+  <step id="build" description="Compile to byte code">
+    <pthon:distutils command="build"/>
+  </step>
+
+  <step id="test" description="Run unit tests">
+    <pthon:distutils command="unittest"/>
+    <reports>
+      <python:unittest file="build/test-results.xml"/>
+      <python:trace summary="build/test-coverage.txt" 
+          coverdir="build/coverage" include="trac*" exclude="*.tests.*"/>
+    </reports>
+  </step>
+
+</recipe>
+}}}