blob: 608deb2c1ffd7a770a2462521aa8b42ecb494d24 [file] [log] [blame]
How To Add Your Build Configuration To LLVM Buildbot Infrastructure
This document contains information about adding a build configuration and
buildbot-worker to private worker builder to LLVM Buildbot Infrastructure.
There are two buildmasters running.
* The main buildmaster at `<>`_. All builders attached
to this machine will notify commit authors every time they break the build.
* The staging buildbot at `<>`_. All builders attached
to this machine will be completely silent by default when the build is broken.
Builders for experimental backends should generally be attached to this
Steps To Add Builder To LLVM Buildbot
Volunteers can provide their build machines to work as build workers to
public LLVM Buildbot.
Here are the steps you can follow to do so:
#. Check the existing build configurations to make sure the one you are
interested in is not covered yet or gets built on your computer much
faster than on the existing one. We prefer faster builds so developers
will get feedback sooner after changes get committed.
#. The computer you will be registering with the LLVM buildbot
infrastructure should have all dependencies installed and you can
actually build your configuration successfully. Please check what degree
of parallelism (-j param) would give the fastest build. You can build
multiple configurations on one computer.
#. Install buildbot-worker (currently we are using buildbot version 2.8.5).
Depending on the platform, buildbot-worker could be available to download and
install with your package manager, or you can download it directly from
`<>`_ and install it manually.
#. Create a designated user account, your buildbot-worker will be running under,
and set appropriate permissions.
#. Choose the buildbot-worker root directory (all builds will be placed under
it), buildbot-worker access name and password the build master will be using
to authenticate your buildbot-worker.
#. Create a buildbot-worker in context of that buildbot-worker account. Point it
to the **** port **9990** (see `Buildbot documentation,
Creating a worker
for more details) by running the following command:
.. code-block:: bash
$ buildbot-worker create-worker <buildbot-worker-root-directory> \ \
<buildbot-worker-access-name> \
To point a worker to silent master please use instead
#. Fill the buildbot-worker description and admin name/e-mail. Here is an
example of the buildbot-worker description::
Windows 7 x64
Core i7 (2.66GHz), 16GB of RAM
g++.exe (TDM-1 mingw32) 4.4.0
GNU Binutils 2.19.1
cmake version 2.8.4
Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
#. Make sure you can actually start the buildbot-worker successfully. Then set
up your buildbot-worker to start automatically at the start up time. See the
buildbot documentation for help. You may want to restart your computer
to see if it works.
#. Send a patch which adds your build worker and your builder to
`zorg <>`_. Use the typical LLVM
`workflow <>`_.
* workers are added to ``buildbot/osuosl/master/config/``
* builders are added to ``buildbot/osuosl/master/config/``
Please make sure your builder name and its builddir are unique through the
It is possible to allow email addresses to unconditionally receive
notifications on build failure; for this you'll need to add an
``InformativeMailNotifier`` to ``buildbot/osuosl/master/config/``.
This is particularly useful for the staging buildmaster which is silent
#. Send the buildbot-worker access name and the access password directly to
`Galina Kistanova <>`_, and wait till she
will let you know that your changes are applied and buildmaster is
#. Check the status of your buildbot-worker on the `Waterfall Display
<>`_ to make sure it is connected, and
```` to see if administrator contact and
worker information are correct.
#. Wait for the first build to succeed and enjoy.