feat: add variant config to [workspace.build-variants] (#2634)

crates/pixi_build_types/src/procedures/conda_build.rs

@@ -1,4 +1,4 @@
-use std::path::PathBuf;
+use std::{collections::HashMap, path::PathBuf};
 
 use rattler_conda_types::GenericVirtualPackage;
 use serde::{Deserialize, Serialize};
@@ -34,6 +34,9 @@ pub struct CondaBuildParams {
     #[serde(default)]
     pub outputs: Option<Vec<CondaOutputIdentifier>>,
 
+    /// The variants that we want to build
+    pub variant_configuration: Option<HashMap<String, Vec<String>>>,
+
     /// A directory that can be used by the backend to store files for
     /// subsequent requests. This directory is unique for each separate source
     /// dependency.

crates/pixi_build_types/src/procedures/conda_metadata.rs

@@ -1,5 +1,5 @@
 use serde::{Deserialize, Serialize};
-use std::path::PathBuf;
+use std::{collections::HashMap, path::PathBuf};
 use url::Url;
 
 use crate::{ChannelConfiguration, CondaPackageMetadata, PlatformAndVirtualPackages};
@@ -27,6 +27,9 @@ pub struct CondaMetadataParams {
     /// The channel configuration to use to resolve dependencies.
     pub channel_configuration: ChannelConfiguration,
 
+    /// The variants that we want to build
+    pub variant_configuration: Option<HashMap<String, Vec<String>>>,
+
     /// A directory that can be used by the backend to store files for
     /// subsequent requests. This directory is unique for each separate source
     /// dependency.

crates/pixi_manifest/src/pyproject.rs

@@ -267,6 +267,7 @@ impl PyProjectManifest {
                 homepage: None,
                 repository: None,
                 documentation: None,
+                build_variants: None,
             })?;
 
         // Add python as dependency based on the `project.requires_python` property

crates/pixi_manifest/src/toml/workspace.rs

@@ -45,6 +45,8 @@ pub struct TomlWorkspace {
 
     #[serde(default)]
     pub preview: Preview,
+
+    pub build_variants: Option<HashMap<String, Vec<String>>>,
 }
 
 /// Defines some of the properties that might be defined in other parts of the
@@ -63,6 +65,7 @@ pub struct ExternalWorkspaceProperties {
     pub homepage: Option<Url>,
     pub repository: Option<Url>,
     pub documentation: Option<Url>,
+    pub build_variants: Option<HashMap<String, Vec<String>>>,
 }
 
 #[derive(Debug, Error)]
@@ -96,6 +99,7 @@ impl TomlWorkspace {
             conda_pypi_map: self.conda_pypi_map,
             pypi_options: self.pypi_options,
             preview: self.preview,
+            build_variants: self.build_variants.or(external.build_variants),
         })
     }
 }

crates/pixi_manifest/src/workspace.rs

@@ -60,4 +60,7 @@ pub struct Workspace {
 
     /// Preview features
     pub preview: Preview,
+
+    /// Build variants
+    pub build_variants: Option<HashMap<String, Vec<String>>>,
 }

schema/model.py

@@ -157,6 +157,9 @@ class Workspace(StrictBaseModel):
     preview: list[KnownPreviewFeature | str] | bool | None = Field(
         None, description="Defines the enabling of preview features of the project"
     )
+    build_variants: dict[NonEmptyStr, list[str]] | None = Field(
+        None, description="The build variants of the project"
+    )
 
 
 class Package(StrictBaseModel):

schema/schema.json

@@ -1543,6 +1543,17 @@
             "John Doe <[email protected]>"
           ]
         },
+        "build-variants": {
+          "title": "Build-Variants",
+          "description": "The build variants of the project",
+          "type": "object",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
         "channel-priority": {
           "$ref": "#/$defs/ChannelPriority",
           "description": "The type of channel priority that is used in the solve.- 'strict': only take the package from the channel it exist in first.- 'disabled': group all dependencies together as if there is no channel difference.",

src/build/mod.rs

@@ -2,6 +2,7 @@ mod cache;
 mod reporters;
 
 use std::{
+    collections::HashMap,
     ffi::OsStr,
     hash::{Hash, Hasher},
     ops::Not,
@@ -13,7 +14,7 @@ use std::{
 use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine};
 use chrono::Utc;
 use itertools::Itertools;
-use miette::Diagnostic;
+use miette::{Diagnostic, IntoDiagnostic};
 use pixi_build_frontend::{BackendOverride, SetupRequest, ToolContext};
 use pixi_build_types::{
     procedures::{
@@ -22,6 +23,7 @@ use pixi_build_types::{
     },
     ChannelConfiguration, CondaPackageMetadata, PlatformAndVirtualPackages,
 };
+use pixi_config::get_cache_dir;
 pub use pixi_glob::{GlobHashCache, GlobHashError};
 use pixi_glob::{GlobHashKey, GlobModificationTime, GlobModificationTimeError};
 use pixi_record::{InputHash, PinnedPathSpec, PinnedSourceSpec, SourceRecord};
@@ -52,6 +54,7 @@ pub struct BuildContext {
     cache_dir: PathBuf,
     work_dir: PathBuf,
     tool_context: Arc<ToolContext>,
+    variant_config: Option<HashMap<String, Vec<String>>>,
 }
 
 #[derive(Debug, Error, Diagnostic)]
@@ -114,6 +117,7 @@ impl BuildContext {
         cache_dir: PathBuf,
         dot_pixi_dir: PathBuf,
         channel_config: ChannelConfig,
+        variant_config: Option<HashMap<String, Vec<String>>>,
         tool_context: Arc<ToolContext>,
     ) -> Result<Self, std::io::Error> {
         Ok(Self {
@@ -124,9 +128,33 @@ impl BuildContext {
             cache_dir,
             work_dir: dot_pixi_dir.join("build-v0"),
             tool_context,
+            variant_config,
         })
     }
 
+    pub fn from_project(project: &crate::project::Project) -> miette::Result<Self> {
+        Self::new(
+            get_cache_dir()?,
+            project.pixi_dir(),
+            project.channel_config(),
+            project
+                .manifest()
+                .workspace
+                .workspace
+                .build_variants
+                .clone(),
+            Arc::new(ToolContext::default()),
+        )
+        .into_diagnostic()
+    }
+
+    pub fn with_tool_context(self, tool_context: Arc<ToolContext>) -> Self {
+        Self {
+            tool_context,
+            ..self
+        }
+    }
+
     /// Sets the input hash cache to use for caching input hashes.
     pub fn with_glob_hash_cache(self, glob_hash_cache: GlobHashCache) -> Self {
         Self {
@@ -291,6 +319,7 @@ impl BuildContext {
                         }
                         .key(),
                     ),
+                    variant_configuration: self.variant_config.clone(),
                 },
                 build_reporter.as_conda_build_reporter(),
             )
@@ -529,6 +558,7 @@ impl BuildContext {
                         }
                         .key(),
                     ),
+                    variant_configuration: self.variant_config.clone(),
                 },
                 metadata_reporter.as_conda_metadata_reporter().clone(),
             )

src/cli/build.rs

@@ -119,6 +119,7 @@ pub async fn execute(args: Args) -> miette::Result<()> {
                 pixi_dir.display()
             )
         })?;
+
     let work_dir = tempfile::Builder::new()
         .prefix("pixi-build-")
         .tempdir_in(project.pixi_dir())
@@ -165,6 +166,7 @@ pub async fn execute(args: Args) -> miette::Result<()> {
                 },
                 outputs: None,
                 work_directory: work_dir.path().to_path_buf(),
+                variant_configuration: Some(Default::default()),
             },
             progress.clone(),
         )

src/lock_file/update.rs

@@ -16,7 +16,6 @@ use indicatif::ProgressBar;
 use itertools::{Either, Itertools};
 use miette::{Diagnostic, IntoDiagnostic, LabeledSpan, MietteDiagnostic, Report, WrapErr};
 use pixi_build_frontend::ToolContext;
-use pixi_config::get_cache_dir;
 use pixi_consts::consts;
 use pixi_manifest::{EnvironmentName, FeaturesExt, HasFeaturesIter};
 use pixi_progress::global_multi_progress;
@@ -680,13 +679,7 @@ pub async fn update_lock_file(
             updated_pypi_prefixes: Default::default(),
             uv_context: None,
             io_concurrency_limit: IoConcurrencyLimit::default(),
-            build_context: BuildContext::new(
-                get_cache_dir()?,
-                project.pixi_dir(),
-                project.channel_config(),
-                Arc::new(ToolContext::default()),
-            )
-            .into_diagnostic()?,
+            build_context: BuildContext::from_project(project)?,
             glob_hash_cache,
         });
     }
@@ -710,13 +703,7 @@ pub async fn update_lock_file(
             updated_pypi_prefixes: Default::default(),
             uv_context: None,
             io_concurrency_limit: IoConcurrencyLimit::default(),
-            build_context: BuildContext::new(
-                get_cache_dir()?,
-                project.pixi_dir(),
-                project.channel_config(),
-                Arc::new(ToolContext::default()),
-            )
-            .into_diagnostic()?,
+            build_context: BuildContext::from_project(project)?,
             glob_hash_cache,
         });
     }
@@ -1011,13 +998,8 @@ impl<'p> UpdateContextBuilder<'p> {
             .with_client(client)
             .build();
 
-        let build_context = BuildContext::new(
-            pixi_config::get_cache_dir()?,
-            project.pixi_dir(),
-            project.channel_config(),
-            tool_context.into(),
-        )
-        .into_diagnostic()?;
+        let build_context =
+            BuildContext::from_project(project)?.with_tool_context(Arc::new(tool_context));
 
         Ok(UpdateContext {
             project,