<!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>Plugin Infrastructure in Buildbot — 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 Manual" href="index.html" />
<link rel="next" title="Buildbot Development" href="../developer/index.html" />
<link rel="prev" title="Optimization" href="optimization.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="optimization.html" title="Optimization"
accesskey="P">previous</a> |
<a href="../developer/index.html" title="Buildbot Development"
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="plugin-infrastructure-in-buildbot">
<h1>Plugin Infrastructure in Buildbot<a class="headerlink" href="#plugin-infrastructure-in-buildbot" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.11.</span></p>
</div>
<p>Plugin infrastructure in Buildbot allows easy use of components that are not part of the core.
It also allows unified access to components that are included in the core.</p>
<p>The following snippet</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">buildbot.plugins</span> <span class="kn">import</span> <span class="n">kind</span>
<span class="o">...</span> <span class="n">kind</span><span class="o">.</span><span class="n">ComponentClass</span> <span class="o">...</span>
</pre></div>
</div>
<p>allows to use a component of kind <code class="docutils literal"><span class="pre">kind</span></code>.
Available <code class="docutils literal"><span class="pre">kind</span></code>s are:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">buildslave</span></code></dt>
<dd>build slaves, described in <a class="reference internal" href="cfg-buildslaves.html"><span class="doc">Buildslaves</span></a></dd>
<dt><code class="docutils literal"><span class="pre">changes</span></code></dt>
<dd>change source, described in <a class="reference internal" href="cfg-changesources.html"><span class="doc">Change Sources</span></a></dd>
<dt><code class="docutils literal"><span class="pre">schedulers</span></code></dt>
<dd>schedulers, described in <a class="reference internal" href="cfg-schedulers.html"><span class="doc">Schedulers</span></a></dd>
<dt><code class="docutils literal"><span class="pre">steps</span></code></dt>
<dd>build steps, described in <a class="reference internal" href="cfg-buildsteps.html"><span class="doc">Build Steps</span></a></dd>
<dt><code class="docutils literal"><span class="pre">status</span></code></dt>
<dd>status targets, described in <a class="reference internal" href="cfg-statustargets.html"><span class="doc">Status Targets</span></a></dd>
<dt><code class="docutils literal"><span class="pre">util</span></code></dt>
<dd>utility classes. For example, <a class="reference internal" href="cfg-builders.html"><span class="doc">BuilderConfig</span></a>, <a class="reference internal" href="cfg-buildfactories.html"><span class="doc">Build Factories</span></a>, <a class="reference internal" href="cfg-schedulers.html#change-filters"><span class="std std-ref">ChangeFilter</span></a> and <a class="reference internal" href="cfg-interlocks.html"><span class="doc">Locks</span></a> are accessible through <code class="docutils literal"><span class="pre">util</span></code>.</dd>
</dl>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>If you are not very familiar with Python and you need to use different kinds of components, start your <code class="docutils literal"><span class="pre">master.cfg</span></code> file with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">buildbot.plugins</span> <span class="k">import</span> <span class="o">*</span>
</pre></div>
</div>
<p class="last">As a result, all listed above components will be available for use.
This is what sample <code class="docutils literal"><span class="pre">master.cfg</span></code> file uses.</p>
</div>
<div class="section" id="developing-plugins">
<h2>Developing Plugins<a class="headerlink" href="#developing-plugins" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="customization.html#plugin-module"><span class="std std-ref">Distribute a Buildbot Plug-In</span></a> contains all necesary information for you to develop new plugins.</p>
</div>
<div class="section" id="plugins-of-note">
<h2>Plugins of note<a class="headerlink" href="#plugins-of-note" title="Permalink to this headline">¶</a></h2>
<p>Plugins were introduced in Buildbot-0.9.0, so as of this writing, only components that are bundled with Buildbot are available as plugins.</p>
<p>If you have an idea/need about extending Buildbot, head to <a class="reference internal" href="../developer/plugins-publish.html"><span class="doc">How to package Buildbot plugins</span></a>, create your own plugins and let the world now how Buildbot can be made even more useful.</p>
</div>
</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 current"><a class="reference internal" href="index.html">Buildbot Manual</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="customization.html">Customization</a></li>
<li class="toctree-l2"><a class="reference internal" href="new-style-steps.html">New-Style Build Steps</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmdline.html">Command-line Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources.html">Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimization.html">Optimization</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Plugin Infrastructure in Buildbot</a><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../developer/index.html">Buildbot Development</a></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="optimization.html" title="Optimization"
>previous</a> |
<a href="../developer/index.html" title="Buildbot Development"
>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/manual/plugins.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>
