annotate llvm/docs/HowToAddABuilder.rst @ 150:1d019706d866

LLVM10
author anatofuz
date Thu, 13 Feb 2020 15:10:13 +0900
parents
children 0572611fdcc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 ===================================================================
anatofuz
parents:
diff changeset
2 How To Add Your Build Configuration To LLVM Buildbot Infrastructure
anatofuz
parents:
diff changeset
3 ===================================================================
anatofuz
parents:
diff changeset
4
anatofuz
parents:
diff changeset
5 Introduction
anatofuz
parents:
diff changeset
6 ============
anatofuz
parents:
diff changeset
7
anatofuz
parents:
diff changeset
8 This document contains information about adding a build configuration and
anatofuz
parents:
diff changeset
9 buildslave to private slave builder to LLVM Buildbot Infrastructure.
anatofuz
parents:
diff changeset
10
anatofuz
parents:
diff changeset
11 Buildmasters
anatofuz
parents:
diff changeset
12 ============
anatofuz
parents:
diff changeset
13
anatofuz
parents:
diff changeset
14 There are two buildmasters running.
anatofuz
parents:
diff changeset
15
anatofuz
parents:
diff changeset
16 * The main buildmaster at `<http://lab.llvm.org:8011>`_. All builders attached
anatofuz
parents:
diff changeset
17 to this machine will notify commit authors every time they break the build.
anatofuz
parents:
diff changeset
18 * The staging buildbot at `<http://lab.llvm.org:8014>`_. All builders attached
anatofuz
parents:
diff changeset
19 to this machine will be completely silent by default when the build is broken.
anatofuz
parents:
diff changeset
20 Builders for experimental backends should generally be attached to this
anatofuz
parents:
diff changeset
21 buildmaster.
anatofuz
parents:
diff changeset
22
anatofuz
parents:
diff changeset
23 Steps To Add Builder To LLVM Buildbot
anatofuz
parents:
diff changeset
24 =====================================
anatofuz
parents:
diff changeset
25 Volunteers can provide their build machines to work as build slaves to
anatofuz
parents:
diff changeset
26 public LLVM Buildbot.
anatofuz
parents:
diff changeset
27
anatofuz
parents:
diff changeset
28 Here are the steps you can follow to do so:
anatofuz
parents:
diff changeset
29
anatofuz
parents:
diff changeset
30 #. Check the existing build configurations to make sure the one you are
anatofuz
parents:
diff changeset
31 interested in is not covered yet or gets built on your computer much
anatofuz
parents:
diff changeset
32 faster than on the existing one. We prefer faster builds so developers
anatofuz
parents:
diff changeset
33 will get feedback sooner after changes get committed.
anatofuz
parents:
diff changeset
34
anatofuz
parents:
diff changeset
35 #. The computer you will be registering with the LLVM buildbot
anatofuz
parents:
diff changeset
36 infrastructure should have all dependencies installed and you can
anatofuz
parents:
diff changeset
37 actually build your configuration successfully. Please check what degree
anatofuz
parents:
diff changeset
38 of parallelism (-j param) would give the fastest build. You can build
anatofuz
parents:
diff changeset
39 multiple configurations on one computer.
anatofuz
parents:
diff changeset
40
anatofuz
parents:
diff changeset
41 #. Install buildslave (currently we are using buildbot version 0.8.5).
anatofuz
parents:
diff changeset
42 Depending on the platform, buildslave could be available to download and
anatofuz
parents:
diff changeset
43 install with your package manager, or you can download it directly from
anatofuz
parents:
diff changeset
44 `<http://trac.buildbot.net>`_ and install it manually.
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 #. Create a designated user account, your buildslave will be running under,
anatofuz
parents:
diff changeset
47 and set appropriate permissions.
anatofuz
parents:
diff changeset
48
anatofuz
parents:
diff changeset
49 #. Choose the buildslave root directory (all builds will be placed under
anatofuz
parents:
diff changeset
50 it), buildslave access name and password the build master will be using
anatofuz
parents:
diff changeset
51 to authenticate your buildslave.
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 #. Create a buildslave in context of that buildslave account. Point it to
anatofuz
parents:
diff changeset
54 the **lab.llvm.org** port **9990** (see `Buildbot documentation,
anatofuz
parents:
diff changeset
55 Creating a slave
anatofuz
parents:
diff changeset
56 <http://docs.buildbot.net/current/tutorial/firstrun.html#creating-a-slave>`_
anatofuz
parents:
diff changeset
57 for more details) by running the following command:
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 .. code-block:: bash
anatofuz
parents:
diff changeset
60
anatofuz
parents:
diff changeset
61 $ buildslave create-slave <buildslave-root-directory> \
anatofuz
parents:
diff changeset
62 lab.llvm.org:9990 \
anatofuz
parents:
diff changeset
63 <buildslave-access-name> <buildslave-access-password>
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 To point a slave to silent master please use lab.llvm.org:9994 instead
anatofuz
parents:
diff changeset
66 of lab.llvm.org:9990.
anatofuz
parents:
diff changeset
67
anatofuz
parents:
diff changeset
68 #. Fill the buildslave description and admin name/e-mail. Here is an
anatofuz
parents:
diff changeset
69 example of the buildslave description::
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 Windows 7 x64
anatofuz
parents:
diff changeset
72 Core i7 (2.66GHz), 16GB of RAM
anatofuz
parents:
diff changeset
73
anatofuz
parents:
diff changeset
74 g++.exe (TDM-1 mingw32) 4.4.0
anatofuz
parents:
diff changeset
75 GNU Binutils 2.19.1
anatofuz
parents:
diff changeset
76 cmake version 2.8.4
anatofuz
parents:
diff changeset
77 Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
anatofuz
parents:
diff changeset
78
anatofuz
parents:
diff changeset
79 #. Make sure you can actually start the buildslave successfully. Then set
anatofuz
parents:
diff changeset
80 up your buildslave to start automatically at the start up time. See the
anatofuz
parents:
diff changeset
81 buildbot documentation for help. You may want to restart your computer
anatofuz
parents:
diff changeset
82 to see if it works.
anatofuz
parents:
diff changeset
83
anatofuz
parents:
diff changeset
84 #. Send a patch which adds your build slave and your builder to zorg.
anatofuz
parents:
diff changeset
85
anatofuz
parents:
diff changeset
86 * slaves are added to ``buildbot/osuosl/master/config/slaves.py``
anatofuz
parents:
diff changeset
87 * builders are added to ``buildbot/osuosl/master/config/builders.py``
anatofuz
parents:
diff changeset
88
anatofuz
parents:
diff changeset
89 Please make sure your builder name and its builddir are unique through the
anatofuz
parents:
diff changeset
90 file.
anatofuz
parents:
diff changeset
91
anatofuz
parents:
diff changeset
92 It is possible to whitelist email addresses to unconditionally receive
anatofuz
parents:
diff changeset
93 notifications on build failure; for this you'll need to add an
anatofuz
parents:
diff changeset
94 ``InformativeMailNotifier`` to ``buildbot/osuosl/master/config/status.py``.
anatofuz
parents:
diff changeset
95 This is particularly useful for the staging buildmaster which is silent
anatofuz
parents:
diff changeset
96 otherwise.
anatofuz
parents:
diff changeset
97
anatofuz
parents:
diff changeset
98 #. Send the buildslave access name and the access password directly to
anatofuz
parents:
diff changeset
99 `Galina Kistanova <mailto:gkistanova@gmail.com>`_, and wait till she
anatofuz
parents:
diff changeset
100 will let you know that your changes are applied and buildmaster is
anatofuz
parents:
diff changeset
101 reconfigured.
anatofuz
parents:
diff changeset
102
anatofuz
parents:
diff changeset
103 #. Check the status of your buildslave on the `Waterfall Display
anatofuz
parents:
diff changeset
104 <http://lab.llvm.org:8011/waterfall>`_ to make sure it is connected, and
anatofuz
parents:
diff changeset
105 ``http://lab.llvm.org:8011/buildslaves/<your-buildslave-name>`` to see
anatofuz
parents:
diff changeset
106 if administrator contact and slave information are correct.
anatofuz
parents:
diff changeset
107
anatofuz
parents:
diff changeset
108 #. Wait for the first build to succeed and enjoy.