3.1. General Documents

This section gives some general information about Buildbot development.

• 3.1.1. Master Organization
  • 3.1.1.1. BuildMaster Object
• 3.1.2. Definitions
  • 3.1.2.1. Repository
  • 3.1.2.2. Project
  • 3.1.2.3. Version Control Comparison
• 3.1.3. Buildbot Coding Style
  • 3.1.3.1. Documentation
  • 3.1.3.2. Symbol Names
  • 3.1.3.3. Twisted Idioms
• 3.1.4. CoffeeScript Coding Style
  • 3.1.4.1. CoffeeScript looks like Python
  • 3.1.4.2. Coffeelint should be happy
  • 3.1.4.3. CoffeeScript syntax sugar
  • 3.1.4.4. CoffeeScript does not include batteries
  • 3.1.4.5. $q “A+ promises” VS twisted’s deferred
• 3.1.5. Buildbot’s Test Suite
  • 3.1.5.1. Quick-Start
  • 3.1.5.2. Suites
  • 3.1.5.3. Mixins
  • 3.1.5.4. Fakes
  • 3.1.5.5. Type Validation
  • 3.1.5.6. Good Tests
• 3.1.6. Configuration
  • 3.1.6.1. Builder Configuration
  • 3.1.6.2. Error Handling
• 3.1.7. Configuration in AngularJS
  • 3.1.7.1. Reconfiguration
• 3.1.8. Writing Schedulers
  • 3.1.8.1. API Stability
  • 3.1.8.2. Implementing A Scheduler
  • 3.1.8.3. Consuming Changes
  • 3.1.8.4. Adding Buildsets
  • 3.1.8.5. Handling Reconfiguration
  • 3.1.8.6. Becoming Active and Inactive
  • 3.1.8.7. Keeping State
• 3.1.9. Utilities
  • 3.1.9.1. buildbot.util.lru
  • 3.1.9.2. buildbot.util.bbcollections
  • 3.1.9.3. buildbot.util.eventual
  • 3.1.9.4. buildbot.util.debounce
  • 3.1.9.5. buildbot.util.poll
  • 3.1.9.6. buildbot.util.maildir
  • 3.1.9.7. buildbot.util.misc
  • 3.1.9.8. buildbot.util.netstrings
  • 3.1.9.9. buildbot.util.sautils
  • 3.1.9.10. buildbot.util.pathmatch
  • 3.1.9.11. buildbot.util.topicmatch
  • 3.1.9.12. buildbot.util.subscription
  • 3.1.9.13. buildbot.util.croniter
  • 3.1.9.14. buildbot.util.state
  • 3.1.9.15. buildbot.util.identifiers
  • 3.1.9.16. buildbot.util.lineboundaries
  • 3.1.9.17. buildbot.util.service
  • 3.1.9.18. buildbot.util.httpclientservice
  • 3.1.9.19. buildbot.test.fake.httpclientservice
  • 3.1.9.20. buildbot.util.ssl
• 3.1.10. Build Result Codes
• 3.1.11. WWW Server
  • 3.1.11.1. History and Motivation
  • 3.1.11.2. Design Overview
  • 3.1.11.3. REST API
  • 3.1.11.4. Server-Side Session
• 3.1.12. Javascript Data Module
  • 3.1.12.1. Base Concepts
• 3.1.13. Base web application
  • 3.1.13.1. JavaScript Application
  • 3.1.13.2. Hacking Quick-Start
  • 3.1.13.3. Guanlecoja
  • 3.1.13.4. Testing Setup
• 3.1.14. Material design Base application
  • 3.1.14.1. Status
• 3.1.15. Authentication
  • 3.1.15.1. Implementation
  • 3.1.15.2. Username / Password Authentication
  • 3.1.15.3. External Authentication
  • 3.1.15.4. Third-Party Authentication
  • 3.1.15.5. Logout
  • 3.1.15.6. Future Additions
• 3.1.16. Authorization
  • 3.1.16.1. Use cases
• 3.1.17. Master-Worker API
  • 3.1.17.1. Connection
  • 3.1.17.2. Workers
  • 3.1.17.3. Setup
  • 3.1.17.4. Pinging
  • 3.1.17.5. Building
  • 3.1.17.6. Worker For Builders
  • 3.1.17.7. Commands
  • 3.1.17.8. Updates
• 3.1.18. Claiming Build Requests
  • 3.1.18.1. Distributing
  • 3.1.18.2. Claiming
  • 3.1.18.3. The One That Got Away
• 3.1.19. String Encodings
  • 3.1.19.1. Inputs
  • 3.1.19.2. Outputs
• 3.1.20. Metrics
  • 3.1.20.1. Metric Events
  • 3.1.20.2. Metric Handlers
  • 3.1.20.3. Metric Watchers
  • 3.1.20.4. Metric Helpers
• 3.1.21. Secrets
• 3.1.22. Secrets manager
• 3.1.23. Secrets providers
  • 3.1.23.1. File provider
  • 3.1.23.2. Vault provider
  • 3.1.23.3. Interpolate secret
  • 3.1.23.4. Secret Obfuscation
  • 3.1.23.5. How to use a secret in a BuildbotService
• 3.1.24. Statistics Service
  • 3.1.24.1. Stats Service
  • 3.1.24.2. Storage backends
  • 3.1.24.3. Capture Classes
• 3.1.25. How to package Buildbot plugins
  • 3.1.25.1. Package the source
  • 3.1.25.2. Making the plugin package
  • 3.1.25.3. Publish the package