particle-os/debian-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Add OSBuild's principles

Browse source
This commit is contained in:
Simon Steinbeiss 2024-02-03 15:11:24 +01:00 • committed by Simon Steinbeiß
parent c0f670f035
commit c431e7e340
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -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.