Skip to content

feat: read the shared config layer instead of pixi's config files #2724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wolfv merged 1 commit into from
Aug 13, 2026
Merged

feat: read the shared config layer instead of pixi's config files #2724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 36 additions & 32 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,31 +139,31 @@ rattler_digest = { version = "1.3.2", default-features = false, features = [
"serde",
] }
rattler_networking = { version = "0.30", default-features = false }
rattler_package_streaming = { version = "0.26", default-features = false }
rattler_package_streaming = { version = "0.27", default-features = false }
rattler_shell = { version = "0.27", default-features = false, features = [
"sysinfo",
] }
rattler_git = { version = "0.2" }
rattler_git = { version = "0.3" }
rattler_prefix_guard = { version = "0.1.2" }

rattler_config = { version = "0.6" }
rattler_config = { version = "0.7" }
rattler = { version = "0.48", default-features = false, features = [
"cli-tools",
"indicatif",
] }
rattler_cache = { version = "0.10", default-features = false }
rattler_index = { version = "0.30", default-features = false }
rattler_index = { version = "0.31", default-features = false }
rattler_upload = { version = "0.10", default-features = false }
rattler_s3 = { version = "0.2.9" }
rattler_redaction = { version = "0.2.2", default-features = false }
rattler_repodata_gateway = { version = "0.31", default-features = false, features = [
rattler_repodata_gateway = { version = "0.32", default-features = false, features = [
"gateway",
] }
rattler_solve = { version = "9.0", default-features = false, features = [
"resolvo",
"serde",
] }
rattler_virtual_packages = { version = "4.1", default-features = false }
rattler_virtual_packages = { version = "5.0", default-features = false }
rattler_menuinst = "0.2"


Expand Down
2 changes: 1 addition & 1 deletion crates/rattler_build_core/src/types/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ impl PlatformWithVirtualPackages {
platform: Platform,
overrides: &VirtualPackageOverrides,
) -> Result<Self, DetectVirtualPackageError> {
let virtual_packages = VirtualPackages::detect_for_platform(platform, overrides)?
let virtual_packages = VirtualPackages::detect_for_platform(platform, overrides, None)?
.into_generic_virtual_packages()
.collect();
Ok(Self {
Expand Down
1 change: 1 addition & 0 deletions crates/rattler_build_source_cache/src/cache.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ impl SourceCache {
// the smudge filter during checkout; `Some(false)` force-skips the
// smudge filter so checkouts contain pointer files only.
lfs: Some(source.lfs),
..Default::default()
};

let fetch_result = self
Expand Down
15 changes: 7 additions & 8 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

Rattler-Build shares its configuration format with pixi: the config file is of the same format as pixi's [global configuration file](https://pixi.sh/latest/reference/pixi_configuration/).

By default (when no `--config-file` is passed), Rattler-Build automatically loads and merges configuration from the standard locations shared by all rattler based tools. Discovery is provided by `rattler_config`'s common `locations` helper, so the search order is identical to the one pixi and other tools use. The locations, in ascending order of precedence (values from later files override values from earlier files):
By default (when no `--config-file` is passed), Rattler-Build automatically loads and merges configuration from the standard locations. Discovery is provided by `rattler_config`'s common `locations` helper, which combines two layers: the configuration shared by all rattler based tools, and Rattler-Build's own files. The locations, in ascending order of precedence (values from later files override values from earlier files):

1. The system-wide configuration of each tool: `/etc/pixi/config.toml` followed by `/etc/rattler-build/config.toml` (on Windows: `C:\ProgramData\<tool>\config.toml`)
2. The per-user configuration of each tool: the platform config directory (`$XDG_CONFIG_HOME/<tool>/config.toml`, e.g. `~/.config/pixi/config.toml`) and the tool home (`$PIXI_HOME` / `$RATTLER_BUILD_HOME`, defaulting to `~/.pixi/config.toml` / `~/.rattler-build/config.toml`), for `pixi` first and then `rattler-build`
1. The system-wide shared configuration: `/etc/rattler/config.toml` (on Windows: `C:\ProgramData\rattler\config.toml`)
2. The system-wide Rattler-Build configuration: `/etc/rattler-build/config.toml`
3. The per-user shared configuration: `$XDG_CONFIG_HOME/rattler/config.toml`, plus `$RATTLER_HOME/config.toml` when the variable is set
4. The per-user Rattler-Build configuration: the platform config directory (`$XDG_CONFIG_HOME/rattler-build/config.toml`) followed by the tool home (`$RATTLER_BUILD_HOME`, defaulting to `~/.rattler-build/config.toml`)

In other words all system-wide files are read before any per-user file, and within each group pixi's files are overridden by Rattler-Build's own files. This means that settings such as default channels, mirrors, or S3 options that you have configured for pixi are picked up by Rattler-Build automatically, and can be overridden in Rattler-Build's own configuration files.
The shared files may only contain the keys every rattler based tool understands — default channels, mirrors, S3 options, and so on. Tool-specific keys in a shared file are ignored with a warning. Settings meant for every tool (pixi and Rattler-Build alike) belong in the shared files; settings meant only for Rattler-Build belong in its own files, which override the shared ones.

Alternatively, a single configuration file can be specified explicitly with `--config-file` (e.g. `--config-file ~/.pixi/config.toml`), which disables the automatic discovery and loads only that file. To disable configuration entirely — so that only built-in defaults and command-line arguments apply — pass `--no-config` (mutually exclusive with `--config-file`).

!!! note "Behavior change"
Earlier versions of Rattler-Build only loaded configuration when `--config-file` was passed. Automatic discovery of the locations above is new: if you already have a pixi configuration, Rattler-Build now picks it up by default. Pass `--no-config` to restore the old behavior and skip all configuration loading, or `--config-file` to load only a specific file.
Alternatively, a single configuration file can be specified explicitly with `--config-file`, which disables the automatic discovery and loads only that file. To disable configuration entirely — so that only built-in defaults and command-line arguments apply — pass `--no-config` (mutually exclusive with `--config-file`).

## Seeing which configuration was loaded

Expand Down
Loading
Loading