Skip to content

Commit

Permalink
add explanation of storage structure in the final package
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfv committed Apr 15, 2024
1 parent d03140d commit b607b6c
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions cep-recipe-serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit b607b6c

Please sign in to comment.