Package Source

By default, the package definition assumes the location of the source to be in the root of the package definition.

For example if your package has the following structure:

my_package
├── pixi.toml
├── src
│   └── my_code.cpp
└── include
    └── my_code.h

Build backends are expected to have reasonable defaults from where to take the source code. Apart from the pixi-build-rattler-build backend where you specify the source in the recipe.yaml, the build backend will default to the directory where the package manifest is located

Alternatively, you can specify where the source is located.

Path

If your source is located somewhere else, you can specify the location of the source using the package.build.source.path field.

For example if your package has the following structure:

my_package
├── pixi.toml
└── source
    ├── src
    │   └── my_code.cpp
    └── include
        └── my_code.h

You can specify the location of the source like this:

[package.build.source]
path = "source"

This will also work with relative paths:

[package.build.source]
path = "../my_other_source_directory"

This works great in combination with git submodules.

Git

If your source is hosted in a git repository, you can specify the repository URL using the package.build.source.git field.

[package.build.source]
git = "https://github.com/user/repo.git"

You can pin to a specific branch, tag, or revision:

[package.build.source]
git = "https://github.com/user/repo.git"
branch = "main"

[package.build.source]
git = "https://github.com/user/repo.git"
tag = "v1.0.0"

[package.build.source]
git = "https://github.com/user/repo.git"
rev = "abc123"

If the source is located in a subdirectory of the repository, you can specify that as well:

[package.build.source]
git = "https://github.com/user/repo.git"
tag = "v1.0.0"
subdirectory = "packages/mypackage"