-
Notifications
You must be signed in to change notification settings - Fork 129
feat: add tool-specific config extension and default config discovery #2636
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.
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
Changes from 4 commits
adebf4f
a7c3da2
fb448a1
cc0b2b9
164336e
be445eb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -208,7 +208,9 @@ pub async fn load_repodatas( | |
| .clear() | ||
| .unwrap(); | ||
|
|
||
| Ok(result) | ||
| // `query` now returns a `RepoDataQueryOutput` (records plus non-fatal | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we emit the warnings here? Or elsewhere? That would be a nice improvement.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah it would be good to add them for sure! Now they are silently dropped. |
||
| // warnings); we only need the repodata records here. | ||
| Ok(result.repodata) | ||
| } | ||
|
|
||
| pub async fn install_packages( | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,33 @@ | ||
| # Rattler-Build configuration | ||
|
|
||
| Rattler-Build can be configured by specifying `--config-file ~/.pixi/config.toml`. | ||
| The config file is of the same format as pixi's [global configuration file](https://pixi.sh/latest/reference/pixi_configuration/). | ||
| 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): | ||
|
|
||
| 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` | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| !!! note "Behavior change" | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we add a mode in which rattler-build doesn't load any configuration so users can preserve the old behavior? |
||
| 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 `--config-file` (pointing at the file you want, or an empty file) to opt out of discovery. | ||
|
|
||
| ## Seeing which configuration was loaded | ||
|
|
||
| On startup Rattler-Build logs its version and the configuration files it actually loaded, so you can always trace where a setting came from: | ||
|
|
||
| ``` | ||
| rattler-build 0.68.0 | ||
| Loaded configuration from: /etc/pixi/config.toml, /home/user/.pixi/config.toml | ||
| ``` | ||
|
|
||
| If no configuration file was found — either because none of the default locations exist, or because `--config-file` was not given — it logs `No configuration file loaded` instead. These lines appear at the default log level; run with `-v` to additionally see the full list of candidate paths that were considered (useful when a file you expected is not picked up). | ||
|
|
||
| ## Programmatic use | ||
|
|
||
| Automatic discovery happens **only when you run the `rattler-build` command-line tool**. When Rattler-Build is used as a library (for example from [pixi](https://pixi.sh), or through the Python bindings), no configuration is loaded implicitly — the embedding application constructs the configuration and passes it in. This guarantees that using Rattler-Build programmatically never silently reads your global pixi or Rattler-Build configuration from disk. | ||
|
|
||
| ## Channels | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be better to only bump minor patches and leave patch bumps in the lockfile only.