feat(bundler): Add RPM packaging, closes #4402 (#5202) (#9809)

* feat(bundler): Add RPM packaging * feat(bundler): Update 'rpm' to 0.13.1 * Fix fmt Co-authored-by: Olivier Lemasle <[email protected]> Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
tauri-apps · May 29, 2024 · 253595a · 253595a
1 parent a020828
commit 253595a
Show file tree

Hide file tree

Showing 19 changed files with 1,357 additions and 147 deletions.
diff --git a/.changes/bundler-rpm.md b/.changes/bundler-rpm.md
@@ -0,0 +1,8 @@
+---
+"tauri-bundler": 'minor:feat'
+"tauri-cli": 'minor:feat'
+"tauri-utils": 'minor:feat'
+"@tauri-apps/cli": 'minor:feat'
+---
+
+Add RPM packaging
diff --git a/core/tauri-config-schema/schema.json b/core/tauri-config-schema/schema.json
@@ -144,6 +144,11 @@
           "macOS": {
             "minimumSystemVersion": "10.13"
           },
+          "rpm": {
+            "epoch": 0,
+            "files": {},
+            "release": "1"
+          },
           "targets": "all",
           "windows": {
             "allowDowngrades": true,
@@ -283,6 +288,11 @@
             "macOS": {
               "minimumSystemVersion": "10.13"
             },
+            "rpm": {
+              "epoch": 0,
+              "files": {},
+              "release": "1"
+            },
             "targets": "all",
             "windows": {
               "allowDowngrades": true,
@@ -1046,7 +1056,7 @@
           "type": "boolean"
         },
         "targets": {
-          "description": "The bundle targets, currently supports [\"deb\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
+          "description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
           "default": "all",
           "allOf": [
             {
@@ -1134,6 +1144,19 @@
             }
           ]
         },
+        "rpm": {
+          "description": "Configuration for the RPM bundle.",
+          "default": {
+            "epoch": 0,
+            "files": {},
+            "release": "1"
+          },
+          "allOf": [
+            {
+              "$ref": "#/definitions/RpmConfig"
+            }
+          ]
+        },
         "macOS": {
           "description": "Configuration for the macOS bundles.",
           "default": {
@@ -1216,6 +1239,13 @@
             "deb"
           ]
         },
+        {
+          "description": "The RPM bundle (.rpm).",
+          "type": "string",
+          "enum": [
+            "rpm"
+          ]
+        },
         {
           "description": "The AppImage bundle (.appimage).",
           "type": "string",
@@ -1344,6 +1374,57 @@
       },
       "additionalProperties": false
     },
+    "RpmConfig": {
+      "description": "Configuration for RPM bundles.",
+      "type": "object",
+      "properties": {
+        "license": {
+          "description": "The package's license identifier. If not set, defaults to the license from the Cargo.toml file.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "depends": {
+          "description": "The list of RPM dependencies your application relies on.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "release": {
+          "description": "The RPM release tag.",
+          "default": "1",
+          "type": "string"
+        },
+        "epoch": {
+          "description": "The RPM epoch.",
+          "default": 0,
+          "type": "integer",
+          "format": "uint32",
+          "minimum": 0.0
+        },
+        "files": {
+          "description": "The files to include on the package.",
+          "default": {},
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "desktopTemplate": {
+          "description": "Path to a custom desktop file Handlebars template.\n\nAvailable variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "MacConfig": {
       "description": "Configuration for the macOS bundles.\n\nSee more: https://tauri.app/v1/api/config#macconfig",
       "type": "object",

diff --git a/core/tauri-utils/src/config.rs b/core/tauri-utils/src/config.rs
@@ -78,6 +78,8 @@ impl Default for WindowUrl {
 pub enum BundleType {
   /// The debian bundle (.deb).
   Deb,
+  /// The RPM bundle (.rpm).
+  Rpm,
   /// The AppImage bundle (.appimage).
   AppImage,
   /// The Microsoft Installer bundle (.msi).
@@ -99,6 +101,7 @@ impl Display for BundleType {
       "{}",
       match self {
         Self::Deb => "deb",
+        Self::Rpm => "rpm",
         Self::AppImage => "appimage",
         Self::Msi => "msi",
         Self::Nsis => "nsis",
@@ -127,6 +130,7 @@ impl<'de> Deserialize<'de> for BundleType {
     let s = String::deserialize(deserializer)?;
     match s.to_lowercase().as_str() {
       "deb" => Ok(Self::Deb),
+      "rpm" => Ok(Self::Rpm),
       "appimage" => Ok(Self::AppImage),
       "msi" => Ok(Self::Msi),
       "nsis" => Ok(Self::Nsis),
@@ -284,6 +288,49 @@ pub struct DebConfig {
   pub changelog: Option<PathBuf>,
 }
 
+/// Configuration for RPM bundles.
+#[skip_serializing_none]
+#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
+#[cfg_attr(feature = "schema", derive(JsonSchema))]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
+pub struct RpmConfig {
+  /// The package's license identifier. If not set, defaults to the license from
+  /// the Cargo.toml file.
+  pub license: Option<String>,
+  /// The list of RPM dependencies your application relies on.
+  pub depends: Option<Vec<String>>,
+  /// The RPM release tag.
+  #[serde(default = "default_release")]
+  pub release: String,
+  /// The RPM epoch.
+  #[serde(default)]
+  pub epoch: u32,
+  /// The files to include on the package.
+  #[serde(default)]
+  pub files: HashMap<PathBuf, PathBuf>,
+  /// Path to a custom desktop file Handlebars template.
+  ///
+  /// Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.
+  pub desktop_template: Option<PathBuf>,
+}
+
+impl Default for RpmConfig {
+  fn default() -> Self {
+    Self {
+      license: None,
+      depends: None,
+      release: default_release(),
+      epoch: 0,
+      files: Default::default(),
+      desktop_template: None,
+    }
+  }
+}
+
+fn default_release() -> String {
+  "1".into()
+}
+
 fn de_minimum_system_version<'de, D>(deserializer: D) -> Result<Option<String>, D::Error>
 where
   D: Deserializer<'de>,
@@ -681,7 +728,7 @@ 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", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all".
+  /// The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all".
   #[serde(default)]
   pub targets: BundleTarget,
   /// The application identifier in reverse domain name notation (e.g. `com.tauri.example`).
@@ -719,6 +766,9 @@ pub struct BundleConfig {
   /// Configuration for the Debian bundle.
   #[serde(default)]
   pub deb: DebConfig,
+  /// Configuration for the RPM bundle.
+  #[serde(default)]
+  pub rpm: RpmConfig,
   /// Configuration for the macOS bundles.
   #[serde(rename = "macOS", default)]
   pub macos: MacConfig,
@@ -3546,6 +3596,7 @@ mod build {
       let long_description = quote!(None);
       let appimage = quote!(Default::default());
       let deb = quote!(Default::default());
+      let rpm = quote!(Default::default());
       let macos = quote!(Default::default());
       let external_bin = opt_vec_str_lit(self.external_bin.as_ref());
       let windows = &self.windows;
@@ -3565,6 +3616,7 @@ mod build {
         long_description,
         appimage,
         deb,
+        rpm,
         macos,
         external_bin,
         windows
@@ -4007,6 +4059,7 @@ mod test {
         long_description: None,
         appimage: Default::default(),
         deb: Default::default(),
+        rpm: Default::default(),
         macos: Default::default(),
         external_bin: None,
         windows: Default::default(),

diff --git a/tooling/bundler/Cargo.toml b/tooling/bundler/Cargo.toml
@@ -65,6 +65,7 @@ regex = "1"
 heck = "0.5"
 ar = "0.9.0"
 md5 = "0.7.0"
+rpm = "0.14.0"
 
 [lib]
 name = "tauri_bundler"

diff --git a/tooling/bundler/src/bundle.rs b/tooling/bundler/src/bundle.rs
@@ -21,7 +21,7 @@ pub use self::{
   category::AppCategory,
   settings::{
     BundleBinary, BundleSettings, DebianSettings, MacOsSettings, PackageSettings, PackageType,
-    Settings, SettingsBuilder, UpdaterSettings,
+    RpmSettings, Settings, SettingsBuilder, UpdaterSettings,
   },
 };
 #[cfg(target_os = "macos")]

diff --git a/tooling/bundler/src/bundle/category.rs b/tooling/bundler/src/bundle/category.rs
@@ -142,9 +142,11 @@ impl AppCategory {
     }
   }
 
-  /// Map an AppCategory to the closest set of GNOME desktop registered
+  /// Map an AppCategory to the closest set of Freedesktop registered
   /// categories that matches that category.
-  pub fn gnome_desktop_categories(self) -> &'static str {
+  ///
+  /// Cf https://specifications.freedesktop.org/menu-spec/latest/
+  pub fn freedesktop_categories(self) -> &'static str {
     match &self {
       AppCategory::Business => "Office;",
       AppCategory::DeveloperTool => "Development;",

diff --git a/tooling/bundler/src/bundle/linux/appimage.rs b/tooling/bundler/src/bundle/linux/appimage.rs
@@ -31,7 +31,6 @@ pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
 
   // generate deb_folder structure
   let (_, icons) = debian::generate_data(settings, &package_dir)?;
-  let icons: Vec<debian::DebIcon> = icons.into_iter().collect();
 
   let output_path = settings.project_out_directory().join("bundle/appimage");
   if output_path.exists() {