Caution

This page documents the latest, unreleased version of Buildbot. For documentation for released versions, see https://docs.buildbot.net/current/.

3.3. General Documents

This section gives some general information about Buildbot development.

• 3.3.1. Master Organization
  • 3.3.1.1. BuildMaster Object
• 3.3.2. Buildbot Coding Style
  • 3.3.2.1. Documentation
  • 3.3.2.2. Symbol Names
  • 3.3.2.3. Twisted Idioms
• 3.3.3. Buildbot’s Test Suite
  • 3.3.3.1. Quick-Start
  • 3.3.3.2. Suites
  • 3.3.3.3. Mixins
  • 3.3.3.4. Fakes
  • 3.3.3.5. Type Validation
  • 3.3.3.6. Good Tests
• 3.3.4. Configuration
  • MasterConfig
  • FileLoader
  • loadConfigDict
  • 3.3.4.1. Builder Configuration
  • 3.3.4.2. Error Handling
• 3.3.5. Configuration in AngularJS
  • buildbot.interfaces.IConfigured
  • buildbot.util.ConfiguredMixin
  • 3.3.5.1. Reconfiguration
• 3.3.6. Writing Schedulers
  • 3.3.6.1. API Stability
  • 3.3.6.2. Implementing A Scheduler
  • 3.3.6.3. Consuming Changes
  • 3.3.6.4. Adding Buildsets
  • 3.3.6.5. Handling Reconfiguration
  • 3.3.6.6. Becoming Active and Inactive
  • 3.3.6.7. Keeping State
• 3.3.7. Utilities
  • naturalSort
  • formatInterval
  • ComparableMixin
  • safeTranslate
  • epoch2datetime
  • datetime2epoch
  • UTC
  • diffSets
  • makeList
  • now
  • flatten
  • flattened_iterator
  • none_or_str
  • bytes2unicode
  • string2boolean
  • toJson
  • NotABranch
  • in_reactor
  • asyncSleep
  • stripUrlPassword
  • join_list
  • Notifier
  • giturlparse
  • GitUrl
  • 3.3.7.1. buildbot.util.lru
  • 3.3.7.2. buildbot.util.bbcollections
  • 3.3.7.3. buildbot.util.eventual
  • 3.3.7.4. buildbot.util.debounce
  • 3.3.7.5. buildbot.util.poll
  • 3.3.7.6. buildbot.util.maildir
  • 3.3.7.7. buildbot.util.misc
  • 3.3.7.8. buildbot.util.netstrings
  • 3.3.7.9. buildbot.util.sautils
  • 3.3.7.10. buildbot.util.pathmatch
  • 3.3.7.11. buildbot.util.topicmatch
  • 3.3.7.12. buildbot.util.subscription
  • 3.3.7.13. buildbot.util.croniter
  • 3.3.7.14. buildbot.util.state
  • 3.3.7.15. buildbot.util.identifiers
  • 3.3.7.16. buildbot.util.lineboundaries
  • 3.3.7.17. buildbot.util.service
  • 3.3.7.18. buildbot.util.httpclientservice
  • 3.3.7.19. buildbot.test.fake.httpclientservice
  • 3.3.7.20. buildbot.util.ssl
• 3.3.8. Build Result Codes
  • SUCCESS
  • WARNINGS
  • FAILURE
  • SKIPPED
  • EXCEPTION
  • RETRY
  • CANCELLED
  • Results
  • worst_status
  • computeResultAndTermination
  • ResultComputingConfigMixin
• 3.3.9. WWW Server
  • 3.3.9.1. History and Motivation
  • 3.3.9.2. Design Overview
  • 3.3.9.3. REST API
  • 3.3.9.4. Server-Side Session
  • 3.3.9.5. Message API
• 3.3.10. Javascript Data Module
  • 3.3.10.1. Base Concepts
• 3.3.11. Base web application
  • 3.3.11.1. JavaScript Application
  • 3.3.11.2. Testing Setup
• 3.3.12. Authentication
  • 3.3.12.1. Implementation
  • 3.3.12.2. Username / Password Authentication
  • 3.3.12.3. External Authentication
  • 3.3.12.4. Third-Party Authentication
  • 3.3.12.5. Logout
  • 3.3.12.6. Future Additions
• 3.3.13. Authorization
  • 3.3.13.1. Use cases
• 3.3.14. Master-Worker API
  • 3.3.14.1. Connection
  • 3.3.14.2. Workers
  • 3.3.14.3. Setup
  • 3.3.14.4. Pinging
  • 3.3.14.5. Building
  • 3.3.14.6. Worker For Builders
  • 3.3.14.7. Commands
  • 3.3.14.8. Updates
• 3.3.15. Master-Worker connection with MessagePack over WebSocket protocol
  • 3.3.15.1. Message key-value pairs
  • 3.3.15.2. Messages from master to worker
  • 3.3.15.3. Messages from worker to master
  • 3.3.15.4. start_command request types
  • 3.3.15.5. Contents of the value corresponding to args key in the dictionary of update request message
• 3.3.16. Claiming Build Requests
  • 3.3.16.1. Distributing
  • 3.3.16.2. Claiming
  • 3.3.16.3. The One That Got Away
• 3.3.17. String Encodings
  • 3.3.17.1. Inputs
  • 3.3.17.2. Outputs
• 3.3.18. Metrics
  • 3.3.18.1. Metric Events
  • 3.3.18.2. Metric Handlers
  • 3.3.18.3. Metric Watchers
  • 3.3.18.4. Metric Helpers
• 3.3.19. Secrets
• 3.3.20. Secrets manager
• 3.3.21. Secrets providers
  • 3.3.21.1. File provider
  • 3.3.21.2. Vault provider
  • 3.3.21.3. Interpolate secret
  • 3.3.21.4. Secret Obfuscation
  • 3.3.21.5. How to use a secret in a BuildbotService
• 3.3.22. Statistics Service
  • 3.3.22.1. Stats Service
  • 3.3.22.2. Storage backends
  • 3.3.22.3. Capture Classes
• 3.3.23. How to package Buildbot plugins
  • 3.3.23.1. Package the source
  • 3.3.23.2. Making the plugin package
  • 3.3.23.3. Publish the package