Caution

Buildbot no longer supports Python 2.7 on the Buildbot master.

3. Buildbot Development

This chapter is the official repository for the collected wisdom of the Buildbot hackers. It is intended both for developers writing patches that will be included in Buildbot itself and for advanced users who wish to customize Buildbot.

Note

Public API

Any API that is not documented in the official Buildbot documentation is considered internal and subject to change. If you would like it to be officially exposed, open a bug report on the Buildbot Github project.

• 3.1. Development Quick-start
  • 3.1.1. Create a Buildbot Python Environment
  • 3.1.2. Create a JavaScript Frontend Environment
• 3.2. Submitting Pull Requests
  • 3.2.1. Guidelines
  • 3.2.2. How to create a pull request
  • 3.2.3. Local testing cheat sheet
• 3.3. General Documents
  • 3.3.1. Master Organization
  • 3.3.2. Buildbot Coding Style
  • 3.3.3. Buildbot’s Test Suite
  • 3.3.4. Configuration
  • 3.3.5. Configuration in AngularJS
  • 3.3.6. Writing Schedulers
  • 3.3.7. Utilities
  • 3.3.8. Build Result Codes
  • 3.3.9. WWW Server
  • 3.3.10. Javascript Data Module
  • 3.3.11. Base web application
  • 3.3.12. Authentication
  • 3.3.13. Authorization
  • 3.3.14. Master-Worker API
  • 3.3.15. Master-Worker connection with MessagePack over WebSocket protocol
  • 3.3.16. Claiming Build Requests
  • 3.3.17. String Encodings
  • 3.3.18. Metrics
  • 3.3.19. Secrets
  • 3.3.20. Secrets manager
  • 3.3.21. Secrets providers
  • 3.3.22. Statistics Service
  • 3.3.23. How to package Buildbot plugins
• 3.4. REST API
  • 3.4.1. Versions
  • 3.4.2. Getting
  • 3.4.3. Collections
  • 3.4.4. Controlling
  • 3.4.5. Authentication
• 3.5. REST API Specification
  • 3.5.1. builder
  • 3.5.2. buildrequest
  • 3.5.3. build
  • 3.5.4. buildset
  • 3.5.5. build_data
  • 3.5.6. change
  • 3.5.7. changesource
  • 3.5.8. forcescheduler
  • 3.5.9. identifier
  • 3.5.10. logchunk
  • 3.5.11. log
  • 3.5.12. master
  • 3.5.13. patch
  • 3.5.14. rootlink
  • 3.5.15. scheduler
  • 3.5.16. sourcedproperties
  • 3.5.17. sourcestamp
  • 3.5.18. spec
  • 3.5.19. step
  • 3.5.20. worker
  • 3.5.21. test_result
  • 3.5.22. test_result_set
  • 3.5.23. Raw endpoints
• 3.6. Data API
  • 3.6.1. Sections
  • 3.6.2. Concrete Interfaces
  • 3.6.3. Extending the Data API
  • 3.6.4. Data Model
• 3.7. Database
  • 3.7.1. Database Overview
  • 3.7.2. Schema
  • 3.7.3. Identifier
  • 3.7.4. Writing Database Connector Methods
  • 3.7.5. Modifying the Database Schema
  • 3.7.6. Foreign key checking
  • 3.7.7. Database Compatibility Notes
  • 3.7.8. Testing migrations with real databases
• 3.8. Database connectors API
  • 3.8.1. Buildsets connector
  • 3.8.2. Buildrequests connector
  • 3.8.3. Builders connector
  • 3.8.4. Builds connector
  • 3.8.5. Build data connector
  • 3.8.6. Steps connector
  • 3.8.7. Logs connector
  • 3.8.8. Changes connector
  • 3.8.9. Change sources connector
  • 3.8.10. Schedulers connector
  • 3.8.11. Source stamps connector
  • 3.8.12. State connector
  • 3.8.13. Users connector
  • 3.8.14. Masters connector
  • 3.8.15. Workers connector
• 3.9. Messaging and Queues
  • 3.9.1. Overview
  • 3.9.2. Connector API
  • 3.9.3. Queue Schema
  • 3.9.4. Message Schema
• 3.10. Classes
  • 3.10.1. Builds
  • 3.10.2. Workers
  • 3.10.3. BuildFactory
  • 3.10.4. Change Sources
  • 3.10.5. RemoteCommands
  • 3.10.6. BuildSteps
  • 3.10.7. BaseScheduler
  • 3.10.8. ForceScheduler
  • 3.10.9. IRenderable
  • 3.10.10. IProperties
  • 3.10.11. IConfigurator
  • 3.10.12. ResultSpecs
  • 3.10.13. Protocols
  • 3.10.14. WorkerManager
  • 3.10.15. Logs
  • 3.10.16. LogObservers
  • 3.10.17. Authentication
  • 3.10.18. Avatars
  • 3.10.19. Web Server Classes