<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Build Result Codes — Buildbot 0.8.12 documentation</title>
<link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.12',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/buildbot.ico"/>
<link rel="top" title="Buildbot 0.8.12 documentation" href="../index.html" />
<link rel="up" title="Buildbot Development" href="index.html" />
<link rel="next" title="File Formats" href="formats.html" />
<link rel="prev" title="Database" href="database.html" />
</head>
<body role="document">
<div class="header-wrapper" role="banner">
<div class="header">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/header-text-transparent.png" alt="Logo"/>
</a></p>
<div class="headertitle"><a
href="../index.html">Buildbot 0.8.12 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="database.html" title="Database"
accesskey="P">previous</a> |
<a href="formats.html" title="File Formats"
accesskey="N">next</a> |
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
accesskey="I">index</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-buildbot.status.results">
<span id="id1"></span><span id="build-result-codes"></span><h1>Build Result Codes<a class="headerlink" href="#module-buildbot.status.results" title="Permalink to this headline">¶</a></h1>
<p>Buildbot represents the status of a step, build, or buildset using a set of
numeric constants. From Python, these constants are available in the module
<code class="docutils literal"><span class="pre">buildbot.status.results</span></code>, but the values also appear in the database and in
external tools, so the values are fixed.</p>
<dl class="data">
<dt id="buildbot.status.results.SUCCESS">
<code class="descclassname">buildbot.status.results.</code><code class="descname">SUCCESS</code><a class="headerlink" href="#buildbot.status.results.SUCCESS" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 0; color: green; a successful run.</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.WARNINGS">
<code class="descclassname">buildbot.status.results.</code><code class="descname">WARNINGS</code><a class="headerlink" href="#buildbot.status.results.WARNINGS" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 1; color: orange; a successful run, with some warnings.</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.FAILURE">
<code class="descclassname">buildbot.status.results.</code><code class="descname">FAILURE</code><a class="headerlink" href="#buildbot.status.results.FAILURE" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 2; color: red; a failed run, due to problems in the build itself, as
opposed to a Buildbot misconfiguration or bug.</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.SKIPPED">
<code class="descclassname">buildbot.status.results.</code><code class="descname">SKIPPED</code><a class="headerlink" href="#buildbot.status.results.SKIPPED" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 3; color: white; a run that was skipped -- usually a step skipped by
<code class="docutils literal"><span class="pre">doStepIf</span></code> (see <a class="reference internal" href="../manual/cfg-buildsteps.html#buildstep-common-parameters"><span class="std std-ref">Common Parameters</span></a>)</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.EXCEPTION">
<code class="descclassname">buildbot.status.results.</code><code class="descname">EXCEPTION</code><a class="headerlink" href="#buildbot.status.results.EXCEPTION" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 4; color: purple; a run that failed due to a problem in Buildbot
itself.</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.RETRY">
<code class="descclassname">buildbot.status.results.</code><code class="descname">RETRY</code><a class="headerlink" href="#buildbot.status.results.RETRY" title="Permalink to this definition">¶</a></dt>
<dd><p>Value: 4; color: purple; a run that should be retried, usually due to a
slave disconnection.</p>
</dd></dl>
<dl class="data">
<dt id="buildbot.status.results.Results">
<code class="descclassname">buildbot.status.results.</code><code class="descname">Results</code><a class="headerlink" href="#buildbot.status.results.Results" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary mapping result codes to their lowercase names.</p>
</dd></dl>
<dl class="function">
<dt id="buildbot.status.results.worst_status">
<code class="descclassname">buildbot.status.results.</code><code class="descname">worst_status</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#buildbot.status.results.worst_status" title="Permalink to this definition">¶</a></dt>
<dd><p>This function takes two status values, and returns the "worst" status of
the two. This is used (with exceptions) to aggregate step statuses into
build statuses, and build statuses into buildset statuses.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Buildbot Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/index.html">Buildbot Manual</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Buildbot Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="master-overview.html">Master Organization</a></li>
<li class="toctree-l2"><a class="reference internal" href="definitions.html">Definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html">Buildbot Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="tests.html">Buildbot's Test Suite</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="database.html">Database</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Build Result Codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="webstatus.html">Web Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="master-slave.html">Master-Slave API</a></li>
<li class="toctree-l2"><a class="reference internal" href="encodings.html">String Encodings</a></li>
<li class="toctree-l2"><a class="reference internal" href="metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins-publish.html">How to package Buildbot plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="classes.html">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../relnotes/index.html">Release Notes for Buildbot 0.8.12</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="database.html" title="Database"
>previous</a> |
<a href="formats.html" title="File Formats"
>next</a> |
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
>index</a>
</div>
<div role="note" aria-label="source link">
<br/>
<a href="../_sources/developer/results.txt"
rel="nofollow">Show Source</a>
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright Buildbot Team Members.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
