Welcome to Debusine’s documentation!

debusine is a general purpose software factory tailored to the needs of a Debian-based distribution. It brings together:

• an artifact storage system

• a task scheduler

• a workflow management system

Documentation for Administrators:

• Runtime environment
• Setting up debusine-server
  • Introduction
  • Initial setup
  • Debusine server commands
  • Configuration with Nginx
  • What the package does on installation
• Setting up debusine-worker
  • Introduction
  • Initial setup
  • Managing debusine-worker
  • Troubleshooting
  • What the package does on installation
• First steps using debusine
  • Introduction
  • Adding and enabling a new worker
    • Enable a new worker on the server based on the worker’s name
    • Enable a new worker on the server based on the token
  • Creating a token for a Debusine client
  • Listing commands
  • Remove tokens
  • Other commands
  • Submit a work request

Documentation for Users:

• Setting up debusine-client
  • Introduction
  • Initial setup
  • Submitting a work request
  • Output of the debusine command
  • Return values

Documentation for Developers:

• Why this project
  • A central place for tasks processing the Debian archive
  • Including package building
  • With custom workflows
  • And GitLab integration
  • Conclusion
• Debusine design
  • Design goals
    • Cloud friendly
    • Vendor neutral
    • Easy to extend
    • Permissions
  • Debusine concepts
    • Artifacts
    • Workspaces
    • Tasks
    • Workflows
  • Ontology
    • For Artifacts
      • Type source-package
      • Type binary-packages
      • Type source-upload
      • Type binary-upload
      • Type package-build-log
    • For Tasks
      • Task PackageBuild
  • Models
  • Tasks
  • Worker
    • Overview
    • Flow
    • Objects documentation
• Contributing
  • Join the community
  • Where to start?
  • How to contribute
  • Write access to the git repository
  • Django Debug Toolbar
• Coding practices
  • Introduction to Test Driven Development
  • About merge requests and code reviews
    • Size of merge requests
    • Discussions in merge requests
    • Use of ‘Draft’ status
    • Usage of ‘Assignee’ and ‘Reviewer’
  • Coding style
  • Git commit messages
  • Good code, good design
    • Models
      • Avoid changing fields from outside the model
      • Push filtering to the model layer
      • Push Model.objects.create() to the model layer
      • Naming fields
      • Model method order
    • Tests
      • Private methods
      • Assert function: order of the parameters
      • Assert functions: assertEqual or specific
    • General guidelines
      • Constants
      • Type hints
      • Early exit

Indices and tables

• Index

• Module Index