From db123ab369f2043d37038a11e3b2d87a84e45c41 Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Mon, 26 Mar 2012 05:13:19 +0200 Subject: README: added some more information --- README | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README b/README index 27db97b..c6e5ca5 100644 --- a/README +++ b/README @@ -8,9 +8,10 @@ have to change some parts, if you want to use it with other versions. The doxygen step should be used, if you are generating docs with [doxygen](http://www.doxygen.org/). It is mainly just cosmetic to -display the step in the build details with a nice heading. To use the -step you could use the following snippet, assuming that this -repository is cloned next to your master.cfg: +display the step in the build details with a nice heading. + +To use the step you could use the following snippet, assuming that +this repository is cloned next to your master.cfg: :::python from buildbot_ext.Doxygen import Doxygen @@ -22,16 +23,33 @@ repository is cloned next to your master.cfg: # CPPUnitTest +The CPPUnitTest step is a simple wrapper for the normal Test step +that adds a link to the test-results to the build page. It does not +transfer the test.xml file to the buildmaster. It assumes that you do +that step manually. + +To use the step you could use the following snippet, assuming that +this repository is cloned next to your master.cfg: + :::python from buildbot_ext.CPPUnitTest import CPPUnitTest build = factory.BuildFactory() # [...] you maybe already have added other steps - build.addStep(CPPUnitTest(command=["make", "test"], workdir="build/test", logfiles={"debug": "debug.log"})) + build.addStep(CPPUnitTest(command=["make", "test"], workdir="build/test", logfiles={"debug": "debug.log"})), + build.addStep(FileUpload(slavesrc="test/test.xml", masterdest=WithProperties("~/public_html/%(buildername)s/%(buildnumber)s/tests/test.xml"))) + build.addStep(FileUpload(slavesrc="test/report.xsl", masterdest=WithProperties("~/public_html/%(buildername)s/%(buildnumber)s/tests/report.xsl"))) # GroupBuildStep +This step simply groups a number of single steps and only show them as +one entry on the build page. It has also the ability to set a number +of links, so that it is perfect suitable to group a few upload tasks. + +To use the step you could use the following snippet, assuming that +this repository is cloned next to your master.cfg: + :::python from buildbot_ext.GroupBuildStep import GroupBuildStep -- cgit v1.2.3