3.2. General Documents

This section gives some general information about Buildbot development.

• 3.2.1. Master Organization
  • 3.2.1.1. BuildMaster Object
• 3.2.2. Buildbot Coding Style
  • 3.2.2.1. Documentation
  • 3.2.2.2. Symbol Names
  • 3.2.2.3. Twisted Idioms
• 3.2.3. CoffeeScript Coding Style
  • 3.2.3.1. CoffeeScript looks like Python
  • 3.2.3.2. Coffeelint should be happy
  • 3.2.3.3. CoffeeScript syntax sugar
  • 3.2.3.4. CoffeeScript does not include batteries
  • 3.2.3.5. $q “A+ promises” VS twisted’s deferred
• 3.2.4. Buildbot’s Test Suite
  • 3.2.4.1. Quick-Start
  • 3.2.4.2. Suites
  • 3.2.4.3. Mixins
  • 3.2.4.4. Fakes
  • 3.2.4.5. Type Validation
  • 3.2.4.6. Good Tests
• 3.2.5. Configuration
  • 3.2.5.1. Builder Configuration
  • 3.2.5.2. Error Handling
• 3.2.6. Configuration in AngularJS
  • 3.2.6.1. Reconfiguration
• 3.2.7. Writing Schedulers
  • 3.2.7.1. API Stability
  • 3.2.7.2. Implementing A Scheduler
  • 3.2.7.3. Consuming Changes
  • 3.2.7.4. Adding Buildsets
  • 3.2.7.5. Handling Reconfiguration
  • 3.2.7.6. Becoming Active and Inactive
  • 3.2.7.7. Keeping State
• 3.2.8. Utilities
  • 3.2.8.1. buildbot.util.lru
  • 3.2.8.2. buildbot.util.bbcollections
  • 3.2.8.3. buildbot.util.eventual
  • 3.2.8.4. buildbot.util.debounce
  • 3.2.8.5. buildbot.util.poll
  • 3.2.8.6. buildbot.util.maildir
  • 3.2.8.7. buildbot.util.misc
  • 3.2.8.8. buildbot.util.netstrings
  • 3.2.8.9. buildbot.util.sautils
  • 3.2.8.10. buildbot.util.pathmatch
  • 3.2.8.11. buildbot.util.topicmatch
  • 3.2.8.12. buildbot.util.subscription
  • 3.2.8.13. buildbot.util.croniter
  • 3.2.8.14. buildbot.util.state
  • 3.2.8.15. buildbot.util.identifiers
  • 3.2.8.16. buildbot.util.lineboundaries
  • 3.2.8.17. buildbot.util.service
  • 3.2.8.18. buildbot.util.httpclientservice
  • 3.2.8.19. buildbot.test.fake.httpclientservice
  • 3.2.8.20. buildbot.util.ssl
• 3.2.9. Build Result Codes
• 3.2.10. WWW Server
  • 3.2.10.1. History and Motivation
  • 3.2.10.2. Design Overview
  • 3.2.10.3. REST API
  • 3.2.10.4. Server-Side Session
• 3.2.11. Javascript Data Module
  • 3.2.11.1. Base Concepts
• 3.2.12. Base web application
  • 3.2.12.1. JavaScript Application
  • 3.2.12.2. Hacking Quick-Start
  • 3.2.12.3. Guanlecoja
  • 3.2.12.4. Testing Setup
• 3.2.13. Authentication
  • 3.2.13.1. Implementation
  • 3.2.13.2. Username / Password Authentication
  • 3.2.13.3. External Authentication
  • 3.2.13.4. Third-Party Authentication
  • 3.2.13.5. Logout
  • 3.2.13.6. Future Additions
• 3.2.14. Authorization
  • 3.2.14.1. Use cases
• 3.2.15. Master-Worker API
  • 3.2.15.1. Connection
  • 3.2.15.2. Workers
  • 3.2.15.3. Setup
  • 3.2.15.4. Pinging
  • 3.2.15.5. Building
  • 3.2.15.6. Worker For Builders
  • 3.2.15.7. Commands
  • 3.2.15.8. Updates
• 3.2.16. Claiming Build Requests
  • 3.2.16.1. Distributing
  • 3.2.16.2. Claiming
  • 3.2.16.3. The One That Got Away
• 3.2.17. String Encodings
  • 3.2.17.1. Inputs
  • 3.2.17.2. Outputs
• 3.2.18. Metrics
  • 3.2.18.1. Metric Events
  • 3.2.18.2. Metric Handlers
  • 3.2.18.3. Metric Watchers
  • 3.2.18.4. Metric Helpers
• 3.2.19. Secrets
• 3.2.20. Secrets manager
• 3.2.21. Secrets providers
  • 3.2.21.1. File provider
  • 3.2.21.2. Vault provider
  • 3.2.21.3. Interpolate secret
  • 3.2.21.4. Secret Obfuscation
  • 3.2.21.5. How to use a secret in a BuildbotService
• 3.2.22. Statistics Service
  • 3.2.22.1. Stats Service
  • 3.2.22.2. Storage backends
  • 3.2.22.3. Capture Classes
• 3.2.23. How to package Buildbot plugins
  • 3.2.23.1. Package the source
  • 3.2.23.2. Making the plugin package
  • 3.2.23.3. Publish the package