This is the Buildbot manual for Buildbot version 2025.04.21.

2. Buildbot Manual

• 2.1. Introduction
  • 2.1.1. System Architecture
• 2.2. Installation
  • 2.2.1. Buildbot Components
  • 2.2.2. Requirements
  • 2.2.3. Installing the code
  • 2.2.4. Buildmaster Setup
  • 2.2.5. Worker Setup
  • 2.2.6. Next Steps
• 2.3. Concepts
  • 2.3.1. Source identification
  • 2.3.2. Change sources
  • 2.3.3. Changes
  • 2.3.4. Schedulers
  • 2.3.5. BuildRequests
  • 2.3.6. Builders and Build Factories
  • 2.3.7. Builds
  • 2.3.8. BuildSets
  • 2.3.9. Workers
  • 2.3.10. Users
  • 2.3.11. Build Properties
• 2.4. Secret Management
  • 2.4.1. Requirements
  • 2.4.2. How to use Buildbot Secret Management
• 2.5. Configuration
  • 2.5.1. Configuring Buildbot
  • 2.5.2. Global Configuration
  • 2.5.3. Change Sources and Changes
  • 2.5.4. Changes
  • 2.5.5. Schedulers
  • 2.5.6. Workers
  • 2.5.7. Builder Configuration
  • 2.5.8. Projects
  • 2.5.9. Codebases
  • 2.5.10. Build Factories
  • 2.5.11. Build Sets
  • 2.5.12. Properties
  • 2.5.13. Build Steps
  • 2.5.14. Interlocks
  • 2.5.15. Report Generators
  • 2.5.16. Reporters
  • 2.5.17. Web Server
  • 2.5.18. Change Hooks
  • 2.5.19. Custom Services
  • 2.5.20. DbConfig
  • 2.5.21. Configurators
  • 2.5.22. Manhole
  • 2.5.23. Multimaster
  • 2.5.24. Multiple-Codebase Builds
  • 2.5.25. Miscellaneous Configuration
  • 2.5.26. Testing Utilities
• 2.6. Customization
  • 2.6.1. Programmatic Configuration Generation
  • 2.6.2. Collapse Request Functions
  • 2.6.3. Builder Priority Functions
  • 2.6.4. Build Priority Functions
  • 2.6.5. Scheduler Priority Functions
  • 2.6.6. canStartBuild Functions
  • 2.6.7. Customizing SVNPoller
  • 2.6.8. Writing Change Sources
  • 2.6.9. Writing a New Latent Worker Implementation
  • 2.6.10. Custom Build Classes
  • 2.6.11. Factory Workdir Functions
  • 2.6.12. Writing New BuildSteps
  • 2.6.13. Writing Dashboards with Flask or Bottle
  • 2.6.14. A Somewhat Whimsical Example (or “It’s now customized, how do I deploy it?”)
• 2.7. Command-line Tool
  • 2.7.1. buildbot
  • 2.7.2. buildbot-worker
• 2.8. Resources
• 2.9. Optimization
  • 2.9.1. Properties load speedup
• 2.10. Plugin Infrastructure in Buildbot
  • 2.10.1. Finding Plugins
  • 2.10.2. Developing Plugins
  • 2.10.3. Plugins of note
• 2.11. Deployment
  • 2.11.1. Using A Database Server
  • 2.11.2. Maintenance
  • 2.11.3. Troubleshooting
• 2.12. Upgrading
  • 2.12.1. Upgrading to Buildbot 5.0 (not released)
  • 2.12.2. Testing support
  • 2.12.3. Non-reconfigurable services
  • 2.12.4. HTTP service
  • 2.12.5. Build factories
  • 2.12.6. Database connectors
  • 2.12.7. Schedulers
  • 2.12.8. Reporters
  • 2.12.9. Data API
  • 2.12.10. Upgrading to Buildbot 4.0
  • 2.12.11. Upgrading to Buildbot 3.0
  • 2.12.12. Upgrading to Buildbot 2.0
  • 2.12.13. Upgrading to Buildbot 1.0
  • 2.12.14. Upgrading to Buildbot 0.9.0
  • 2.12.15. New-Style Build Steps in Buildbot 0.9.0
  • 2.12.16. Transition to “worker” terminology in BuildBot 0.9.0