From c431e7e340ad7926ad0fd24d7a24709240b3f8ff Mon Sep 17 00:00:00 2001 From: Simon Steinbeiss Date: Sat, 3 Feb 2024 15:11:24 +0100 Subject: [PATCH] README: Add OSBuild's principles --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index eae4ea9f..42862848 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,15 @@ of the pipeline description, and more. * **Mailing List**: image-builder@redhat.com * **Changelog**: https://github.com/osbuild/osbuild/releases +### Principles + +1. [OSBuild stages](./stages) are never broken, only deprecated. The same manifest should always produce the same output. +2. [OSBuild stages](./stages) should be explicit whenever possible instead of e.g. relying on the state of the tree. +3. Pipelines are independent, so the tree is expected to be empty at the beginning of each. +4. Manifests are expected to be machine-generated, so OSBuild has no convenience functions to support manually created manifests. +5. The build environment is confined against accidental misuse, but this should not be considered a security boundary. +6. OSBuild may only use Python language features supported by the oldest target distribution. + ### Contributing Please refer to the [developer guide](https://www.osbuild.org/guides/developer-guide/index.html) to learn about our workflow, code style and more.