feat!(core): add bundle createUpdaterArtifacts configuration

.changes/separate-updater-field.md

@@ -0,0 +1,8 @@
+---
+"tauri-utils": patch:breaking
+"tauri-bundler": patch:breaking
+"tauri-cli": patch:breaking
+"@tauri-apps/cli": patch:breaking
+---
+
+Move updater target from `bundle > targets` to a separate field `bundle > updater`

core/tauri-config-schema/schema.json

@@ -72,6 +72,7 @@
         "android": {
           "minSdkVersion": 24
         },
+        "createUpdaterArtifacts": false,
         "iOS": {},
         "icon": [],
         "linux": {
@@ -1517,14 +1518,23 @@
           "type": "boolean"
         },
         "targets": {
-          "description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
+          "description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\"] or \"all\".",
           "default": "all",
           "allOf": [
             {
               "$ref": "#/definitions/BundleTarget"
             }
           ]
         },
+        "createUpdaterArtifacts": {
+          "description": "Produce updaters and their signatures or not",
+          "default": false,
+          "allOf": [
+            {
+              "$ref": "#/definitions/Updater"
+            }
+          ]
+        },
         "publisher": {
           "description": "The application's publisher. Defaults to the second element in the identifier string. Currently maps to the Manufacturer property of the Windows Installer.",
           "type": [
@@ -1784,12 +1794,34 @@
           "enum": [
             "dmg"
           ]
+        }
+      ]
+    },
+    "Updater": {
+      "description": "Updater type",
+      "anyOf": [
+        {
+          "description": "Generates lagacy zipped v1 compatible updaters",
+          "allOf": [
+            {
+              "$ref": "#/definitions/V1Compatible"
+            }
+          ]
         },
         {
-          "description": "The Tauri updater bundle.",
+          "description": "Produce updaters and their signatures or not",
+          "type": "boolean"
+        }
+      ]
+    },
+    "V1Compatible": {
+      "description": "Generates lagacy zipped v1 compatible updaters",
+      "oneOf": [
+        {
+          "description": "Generates lagacy zipped v1 compatible updaters",
           "type": "string",
           "enum": [
-            "updater"
+            "v1Compatible"
           ]
         }
       ]

core/tauri-utils/src/config.rs

@@ -115,8 +115,6 @@ pub enum BundleType {
   App,
   /// The Apple Disk Image bundle (.dmg).
   Dmg,
-  /// The Tauri updater bundle.
-  Updater,
 }
 
 impl BundleType {
@@ -130,7 +128,6 @@ impl BundleType {
       BundleType::Nsis,
       BundleType::App,
       BundleType::Dmg,
-      BundleType::Updater,
     ]
   }
 }
@@ -148,7 +145,6 @@ impl Display for BundleType {
         Self::Nsis => "nsis",
         Self::App => "app",
         Self::Dmg => "dmg",
-        Self::Updater => "updater",
       }
     )
   }
@@ -177,7 +173,6 @@ impl<'de> Deserialize<'de> for BundleType {
       "nsis" => Ok(Self::Nsis),
       "app" => Ok(Self::App),
       "dmg" => Ok(Self::Dmg),
-      "updater" => Ok(Self::Updater),
       _ => Err(DeError::custom(format!("unknown bundle target '{s}'"))),
     }
   }
@@ -1037,6 +1032,33 @@ impl BundleResources {
   }
 }
 
+/// Updater type
+#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
+#[cfg_attr(feature = "schema", derive(JsonSchema))]
+#[serde(rename_all = "camelCase", deny_unknown_fields, untagged)]
+pub enum Updater {
+  /// Generates lagacy zipped v1 compatible updaters
+  String(V1Compatible),
+  /// Produce updaters and their signatures or not
+  // Can't use untagged on enum field here: https://github.com/GREsau/schemars/issues/222
+  Bool(bool),
+}
+
+impl Default for Updater {
+  fn default() -> Self {
+    Self::Bool(false)
+  }
+}
+
+/// Generates lagacy zipped v1 compatible updaters
+#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
+#[cfg_attr(feature = "schema", derive(JsonSchema))]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
+pub enum V1Compatible {
+  /// Generates lagacy zipped v1 compatible updaters
+  V1Compatible,
+}
+
 /// Configuration for tauri-bundler.
 ///
 /// See more: <https://tauri.app/v1/api/config#bundleconfig>
@@ -1048,9 +1070,12 @@ pub struct BundleConfig {
   /// Whether Tauri should bundle your application or just output the executable.
   #[serde(default)]
   pub active: bool,
-  /// The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all".
+  /// The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg"] or "all".
   #[serde(default)]
   pub targets: BundleTarget,
+  #[serde(default)]
+  /// Produce updaters and their signatures or not
+  pub create_updater_artifacts: Updater,
   /// The application's publisher. Defaults to the second element in the identifier string.
   /// Currently maps to the Manufacturer property of the Windows Installer.
   pub publisher: Option<String>,
@@ -2419,6 +2444,7 @@ mod build {
       let icon = vec_lit(&self.icon, str_lit);
       let active = self.active;
       let targets = quote!(Default::default());
+      let create_updater_artifacts = quote!(Default::default());
       let resources = quote!(None);
       let copyright = quote!(None);
       let category = quote!(None);
@@ -2441,6 +2467,7 @@ mod build {
         publisher,
         icon,
         targets,
+        create_updater_artifacts,
         resources,
         copyright,
         category,
@@ -2755,6 +2782,7 @@ mod test {
     let bundle = BundleConfig {
       active: false,
       targets: Default::default(),
+      create_updater_artifacts: Default::default(),
       publisher: None,
       icon: Vec::new(),
       resources: None,

tooling/bundler/src/bundle.rs

@@ -42,16 +42,14 @@ pub struct Bundle {
 
 /// Bundles the project.
 /// Returns the list of paths where the bundles can be found.
-pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
+pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<Bundle>> {
   let mut package_types = settings.package_types()?;
   if package_types.is_empty() {
     return Ok(Vec::new());
   }
 
   package_types.sort_by_key(|a| a.priority());
 
-  let mut bundles: Vec<Bundle> = Vec::new();
-
   let target_os = settings
     .target()
     .split('-')
@@ -68,7 +66,7 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
     if settings.can_sign() {
       for bin in settings.binaries() {
         let bin_path = settings.binary_path(bin);
-        windows::sign::try_sign(&bin_path, &settings)?;
+        windows::sign::try_sign(&bin_path, settings)?;
       }
 
       // Sign the sidecar binaries
@@ -89,14 +87,15 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
           continue;
         }
 
-        windows::sign::try_sign(&path, &settings)?;
+        windows::sign::try_sign(&path, settings)?;
       }
     } else {
       #[cfg(not(target_os = "windows"))]
       log::warn!("Signing, by default, is only supported on Windows hosts, but you can specify a custom signing command in `bundler > windows > sign_command`, for now, skipping signing the installer...");
     }
   }
 
+  let mut bundles = Vec::<Bundle>::new();
   for package_type in &package_types {
     // bundle was already built! e.g. DMG already built .app
     if bundles.iter().any(|b| b.package_type == *package_type) {
@@ -105,13 +104,13 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
 
     let bundle_paths = match package_type {
       #[cfg(target_os = "macos")]
-      PackageType::MacOsBundle => macos::app::bundle_project(&settings)?,
+      PackageType::MacOsBundle => macos::app::bundle_project(settings)?,
       #[cfg(target_os = "macos")]
-      PackageType::IosBundle => macos::ios::bundle_project(&settings)?,
+      PackageType::IosBundle => macos::ios::bundle_project(settings)?,
       // dmg is dependent of MacOsBundle, we send our bundles to prevent rebuilding
       #[cfg(target_os = "macos")]
       PackageType::Dmg => {
-        let bundled = macos::dmg::bundle_project(&settings, &bundles)?;
+        let bundled = macos::dmg::bundle_project(settings, &bundles)?;
         if !bundled.app.is_empty() {
           bundles.push(Bundle {
             package_type: PackageType::MacOsBundle,
@@ -122,33 +121,15 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
       }
 
       #[cfg(target_os = "windows")]
-      PackageType::WindowsMsi => windows::msi::bundle_project(&settings, false)?,
-      PackageType::Nsis => windows::nsis::bundle_project(&settings, false)?,
+      PackageType::WindowsMsi => windows::msi::bundle_project(settings, false)?,
+      PackageType::Nsis => windows::nsis::bundle_project(settings, false)?,
 
       #[cfg(target_os = "linux")]
-      PackageType::Deb => linux::debian::bundle_project(&settings)?,
+      PackageType::Deb => linux::debian::bundle_project(settings)?,
       #[cfg(target_os = "linux")]
-      PackageType::Rpm => linux::rpm::bundle_project(&settings)?,
+      PackageType::Rpm => linux::rpm::bundle_project(settings)?,
       #[cfg(target_os = "linux")]
-      PackageType::AppImage => linux::appimage::bundle_project(&settings)?,
-
-      // updater is dependent of multiple bundle, we send our bundles to prevent rebuilding
-      PackageType::Updater => {
-        if !package_types.iter().any(|p| {
-          matches!(
-            p,
-            PackageType::AppImage
-              | PackageType::MacOsBundle
-              | PackageType::Dmg
-              | PackageType::Nsis
-              | PackageType::WindowsMsi
-          )
-        }) {
-          log::warn!("The updater bundle target exists but couldn't find any updater-enabled target, so the updater artifacts won't be generated. Please add one of these targets as well: app, appimage, msi, nsis");
-          continue;
-        }
-        updater_bundle::bundle_project(&settings, &bundles)?
-      }
+      PackageType::AppImage => linux::appimage::bundle_project(settings)?,
       _ => {
         log::warn!("ignoring {}", package_type.short_name());
         continue;
@@ -161,6 +142,33 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
     });
   }
 
+  if let Some(updater) = settings.updater() {
+    if package_types.iter().any(|package_type| {
+      if updater.v1_compatible {
+        matches!(
+          package_type,
+          PackageType::AppImage
+            | PackageType::MacOsBundle
+            | PackageType::Nsis
+            | PackageType::WindowsMsi
+        )
+      } else {
+        matches!(package_type, PackageType::MacOsBundle)
+      }
+    }) {
+      let updater_paths = updater_bundle::bundle_project(settings, &bundles)?;
+      bundles.push(Bundle {
+        package_type: PackageType::Updater,
+        bundle_paths: updater_paths,
+      });
+    } else if updater.v1_compatible {
+      log::warn!("The updater bundle target exists but couldn't find any updater-enabled target, so the updater artifacts won't be generated. Please add one of these targets as well: app, appimage, msi, nsis");
+    }
+    if updater.v1_compatible {
+      log::warn!("Legacy v1 compatible updater is deprecated and will be removed in v3, change bundle > createUpdaterArtifacts to true when your users are updated to the version with v2 updater plugin");
+    }
+  }
+
   #[cfg(target_os = "macos")]
   {
     // Clean up .app if only building dmg or updater
@@ -188,34 +196,37 @@ pub fn bundle_project(settings: Settings) -> crate::Result<Vec<Bundle>> {
     }
   }
 
-  if !bundles.is_empty() {
-    let bundles_wo_updater = bundles
-      .iter()
-      .filter(|b| b.package_type != PackageType::Updater)
-      .collect::<Vec<_>>();
-    let pluralised = if bundles_wo_updater.len() == 1 {
-      "bundle"
-    } else {
-      "bundles"
-    };
+  if bundles.is_empty() {
+    return Err(anyhow::anyhow!("No bundles were built").into());
+  }
 
-    let mut printable_paths = String::new();
-    for bundle in &bundles {
-      for path in &bundle.bundle_paths {
-        let mut note = "";
-        if bundle.package_type == crate::PackageType::Updater {
-          note = " (updater)";
-        }
-        writeln!(printable_paths, "        {}{}", display_path(path), note).unwrap();
-      }
+  let bundles_wo_updater = bundles
+    .iter()
+    .filter(|b| b.package_type != PackageType::Updater)
+    .collect::<Vec<_>>();
+  let finished_bundles = bundles_wo_updater.len();
+  let pluralised = if finished_bundles == 1 {
+    "bundle"
+  } else {
+    "bundles"
+  };
+
+  let mut printable_paths = String::new();
+  for bundle in &bundles {
+    for path in &bundle.bundle_paths {
+      let note = if bundle.package_type == crate::PackageType::Updater {
+        " (updater)"
+      } else {
+        ""
+      };
+      let path_display = display_path(path);
+      writeln!(printable_paths, "        {path_display}{note}").unwrap();
     }
+  }
 
-    log::info!(action = "Finished"; "{} {} at:\n{}", bundles_wo_updater.len(), pluralised, printable_paths);
+  log::info!(action = "Finished"; "{finished_bundles} {pluralised} at:\n{printable_paths}");
 
-    Ok(bundles)
-  } else {
-    Err(anyhow::anyhow!("No bundles were built").into())
-  }
+  Ok(bundles)
 }
 
 /// Check to see if there are icons in the settings struct