Buildbot Documentation Release 2.5.1 Brian Warner Nov 24, 2019 Contents 1 Buildbot Tutorial 3 1.1 First Run.................................................3 1.2 First Buildbot run with Docker......................................6 1.3 A Quick Tour...............................................9 1.4 Further Reading............................................. 17 2 Buildbot Manual 23 2.1 Introduction............................................... 23 2.2 Installation................................................ 29 2.3 Concepts................................................. 43 2.4 Secret Management........................................... 52 2.5 Configuration............................................... 56 2.6 Customization.............................................. 265 2.7 Command-line Tool........................................... 292 2.8 Resources................................................. 303 2.9 Optimization............................................... 303 2.10 Plugin Infrastructure in Buildbot..................................... 304 2.11 Deployment............................................... 305 2.12 Upgrading................................................ 309 3 Buildbot Development 323 3.1 Development Quick-start......................................... 323 3.2 Submitting Pull Requests........................................ 326 3.3 General Documents........................................... 329 3.4 APIs................................................... 409 3.5 Classes.................................................. 502 4 Release Notes 541 4.1 Buildbot 2.5.1 ( 2019-11-24 )................................... 541 4.2 Buildbot 2.5.0 ( 2019-10-17 )................................... 541 4.3 Buildbot 2.4.1 ( 2019-09-11 )................................... 542 4.4 Buildbot 2.4.0 ( 2019-08-18 )................................... 542 4.5 Buildbot 2.3.1 ( 2019-05-22 )................................... 544 4.6 Buildbot 2.3.0 ( 2019-05-06 )................................... 544 4.7 Buildbot 2.2.0 ( 2019-04-07 )................................... 545 4.8 Buildbot 2.1.0 ( 2019-03-09 )................................... 545 4.9 Buildbot 2.0.1 ( 2019-02-06 )................................... 546 i 4.10 Buildbot 2.0.0 ( 2019-02-02 )................................... 546 4.11 Buildbot 1.8.2 ( 2019-05-22 )................................... 547 4.12 Buildbot 1.8.1 ( 2019-02-02 )................................... 547 4.13 Buildbot 1.8.0 ( 2019-01-20 )................................... 547 4.14 Buildbot 1.7.0 ( 2018-12-21 )................................... 548 4.15 Buildbot 1.6.0 ( 2018-11-16 )................................... 549 4.16 Buildbot 1.5.0 ( 2018-10-09 )................................... 549 4.17 Buildbot 1.4.0 ( 2018-09-02 )................................... 550 4.18 Buildbot 1.3.0 ( 2018-07-13 )................................... 551 4.19 Buildbot 1.2.0 ( 2018-06-10 )................................... 551 4.20 Buildbot 1.1.2 ( 2018-05-15 )................................... 552 4.21 Buildbot 1.1.1 ( 2018-04-06 )................................... 553 4.22 Buildbot 1.1.0 ( 2018-03-10 )................................... 553 4.23 Buildbot 1.0.0 ( 2018-02-11 )................................... 554 4.24 Buildbot 0.9.15.post1 ( 2018-01-07 ).............................. 555 4.25 Buildbot 0.9.15 ( 2018-01-02 ).................................. 555 4.26 Buildbot 0.9.14 ( 2017-12-08 ).................................. 556 4.27 Buildbot 0.9.13 ( 2017-11-07 ).................................. 557 4.28 Buildbot 0.9.12.post1 ( 2017-10-10 ).............................. 558 4.29 Buildbot 0.9.12 ( 2017-10-05 ).................................. 558 4.30 Buildbot 0.9.11 ( 2017-09-08 ).................................. 559 4.31 Buildbot 0.9.10 ( 2017-08-03 ).................................. 560 4.32 Buildbot 0.9.9.post2 ( 2017-07-06 ).............................. 561 4.33 Buildbot 0.9.9.post1 ( 2017-07-01 ).............................. 561 4.34 Buildbot 0.9.9 ( 2017-06-29 )................................... 561 4.35 Buildbot 0.9.8 ( 2017-06-14 )................................... 562 4.36 Buildbot 0.9.7 ( 2017-05-09 )................................... 563 4.37 Buildbot 0.9.6 ( 2017-04-19 )................................... 564 4.38 Buildbot 0.9.5 ( 2017-03-18 )................................... 565 4.39 Buildbot 0.9.4 ( 2017-02-08 )................................... 566 4.40 Buildbot 0.9.3 ( 2017-01-11 )................................... 567 4.41 Buildbot 0.9.2 ( 2016-12-13 )................................... 568 5 Older Release Notes 571 5.1 Release Notes for Buildbot 0.9.1 ................................... 571 5.2 Release Notes for Buildbot 0.9.0 ................................... 574 5.3 Release Notes for Buildbot 0.9.0rc4 ................................. 585 5.4 Release Notes for Buildbot 0.9.0rc3 ................................. 585 5.5 Release Notes for Buildbot 0.9.0rc2 ................................. 586 5.6 Release Notes for Buildbot 0.9.0rc1 ................................. 587 5.7 Release Notes for Buildbot 0.9.0b9................................... 589 5.8 Release Notes for Buildbot 0.9.0b8................................... 591 5.9 Release Notes for Buildbot 0.9.0b7................................... 598 5.10 Release Notes for Buildbot 0.9.0b6................................... 599 5.11 Release Notes for Buildbot 0.9.0b5................................... 600 5.12 Release Notes for Buildbot 0.9.0b4................................... 600 5.13 Release Notes for Buildbot 0.9.0b3................................... 601 5.14 Release Notes for Buildbot 0.9.0b2................................... 602 5.15 Release Notes for Buildbot 0.9.0b1................................... 604 5.16 Release Notes for Buildbot 0.8.11.................................... 611 5.17 Release Notes for Buildbot 0.8.10.................................... 613 5.18 Release Notes for Buildbot 0.8.9..................................... 614 5.19 Release Notes for Buildbot v0.8.8.................................... 621 5.20 Release Notes for Buildbot v0.8.7.................................... 623 ii 5.21 Release Notes for Buildbot v0.8.6p1................................... 628 6 Indices and Tables 633 7 Copyright 635 Python Module Index 637 Buildmaster Configuration Index 639 Scheduler Index 641 Change Source Index 643 Build Step Index 645 Reporter Target Index 647 Configurator Target Index 649 Build Worker Index 651 Command Line Index 653 Data API Event Index 655 REST/Data API Resource Type Index 657 REST/Data API Path Index 659 REST/Data API Actions Index 661 Index 663 iii iv Buildbot Documentation, Release 2.5.1 Caution: Buildbot no longer supports Python 2.7 on the Buildbot master. This is the Buildbot documentation for Buildbot version 2.5.1. If you are evaluating Buildbot and would like to get started quickly, start with the Tutorial. Regular users of Buildbot should consult the Manual, and those wishing to modify Buildbot directly will want to be familiar with the Developer’s Documentation. Caution: Buildbot no longer supports Python 2.7 on the Buildbot master. Contents 1 Buildbot Documentation, Release 2.5.1 2 Contents CHAPTER 1 Buildbot Tutorial Contents: Caution: Buildbot no longer supports Python 2.7 on the Buildbot master. 1.1 First Run 1.1.1 Goal This tutorial will take you from zero to running your first buildbot master and worker as quickly as possible, without changing the default configuration. This tutorial is all about instant gratification and the five minute experience: in five minutes we want to convince you that this project works, and that you should seriously consider spending time learning the system. In this tutorial no configuration or code changes are done. This tutorial assumes that you are running Unix, but might be adaptable to Windows. Thanks to virtualenv (https://pypi.python.org/pypi/virtualenv), installing buildbot in a standalone environment is very easy. For those more familiar with Docker (https://docker.com), there also exists a docker version of these instructions. You should be able to cut and paste each shell block from this tutorial directly into a terminal. 1.1.2 Getting ready There are many ways to get the code on your machine. We will use the easiest one: via pip in a virtualenv (https://pypi.python.org/pypi/virtualenv). It has the advantage of not polluting your operating system, as everything will be contained in the virtualenv. To make this work, you will need the following installed: • Python (https://www.python.org/) and the development packages for it 3 Buildbot Documentation, Release 2.5.1 • virtualenv (https://pypi.python.org/pypi/virtualenv) Preferably, use your distribution package manager to install these. You will also need a working Internet connection, as virtualenv and pip will need to download other projects from the Internet. The master and builder daemons will need to be able to connect to github.com via HTTPS to fetch the repo we’re testing; if you need to use a proxy for this ensure that either the HTTPS_PROXY or ALL_PROXY environment variable is set to your proxy, e.g., by executing export HTTPS_PROXY=http://localhost:9080 in the shell before starting each daemon. Note: Buildbot does not require root access. Run the commands in this tutorial as a normal, unprivileged user. 1.1.3 Creating a master The first necessary step is to create a virtualenv for our master. We will also use a separate directory to demonstrate the distinction between a master