From b607b6ca0a38f235dcf61bfea4688eaab9e4c324 Mon Sep 17 00:00:00 2001 From: Wolf Vollprecht Date: Mon, 15 Apr 2024 09:26:00 +0200 Subject: [PATCH] add explanation of storage structure in the final package --- cep-recipe-serialization.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/cep-recipe-serialization.md b/cep-recipe-serialization.md index cf51cc36..51177eeb 100644 --- a/cep-recipe-serialization.md +++ b/cep-recipe-serialization.md @@ -11,6 +11,38 @@ The goal is to have a single file that contains all the information needed to reproduce an exact build of a package. This will enable better reproducibility, provenance tracking, and debugging of conda packages. +## Storage + +The rendered recipe YAML file is stored in the `info/recipe` folder of the final +package. Alongside the rendered recipe, we copy the entire "recipe folder". +If the original recipe was not named `recipe.yaml`, then we rename it inside the package. + +For example: + +```txt +├── recipe + ├── patches + │ └── patch1.diff + ├── build.sh + ├── build.bat + └── my_recipe.yaml +``` + +Will be copied into the following folder structure in the final package: + +```txt +├── ... +├── index.json +└── recipe + ├── build.bat + ├── build.sh + ├── recipe.yaml + ├── patches + │ └── patch1.diff + ├── rendered_recipe.yaml + └── variant_config.yaml +``` + ## Specification The rendered recipe YAML file contains the following top-level sections: