chore: Add documentation for StageList and ModuleList

This commit is contained in:
Gerald Pinder 2024-10-13 20:57:44 -04:00
parent 27ff5d3bc5
commit ddd1864c3f
2 changed files with 13 additions and 4 deletions

View file

@ -58,6 +58,10 @@ model Recipe {
@jsonSchema("stage-list-v1.json")
model StageList {
/**
* A list of [stages](https://blue-build.org/reference/stages/) that are executed before the build of the final image.
* This is useful for compiling programs from source without polluting the final bootable image.
*/
stages: Array<Stage | ImportedModule>;
}
@ -83,6 +87,11 @@ model Stage {
@jsonSchema("module-list-v1.json")
model ModuleList {
/**
* A list of [modules](https://blue-build.org/reference/module/) that is executed in order. Multiple of the same module can be included.
*
* Each item in this list should have at least a `type:` or be specified to be included from an external file in the `recipes/` directory with `from-file:`.
*/
modules: Array<ModuleType | ImportedModule>;
}