BuildStream Documentation

About BuildStream

BuildStream is a flexible and extensible framework for the modelling of build pipelines in a declarative YAML format, written in python.

These pipelines are composed of abstract elements which perform mutations on on filesystem data as input and output, and are related to eachother by their dependencies.

Installing

• BuildStream on your host
• BuildStream inside Docker
• Artifact Caches

Running

• Invoking BuildStream
• User Configuration

Project format

• Introduction
  • Directory Structure
  • Composition
  • Directives
• Project Configuration
  • Essentials
  • External Plugins
  • Options
  • Specifying Defaults
  • Builtin Defaults
• Element Constructs
  • Element Basics
  • Dependencies
  • Using Variables
• Builtin Public Data

Builtin Plugins

• Plugins
  • Elements
  • Sources

External Plugins

• bst-external

Creating Plugins

• Authoring Plugins
  • Core Framework

Internals

• Cache Keys

Indices and tables

• Module Index
• Index