Merge branch '8197-switch-from-gzip-compression-to-xz-compression-for-packages' into 'master'

Switch from gzip compression to xz compression for packages

Closes #8197

See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7128

Merged-by: Balasankar 'Balu' C <[email protected]>
Approved-by: Mitchell Nielsen <[email protected]>
Approved-by: Clemens Beck <[email protected]>
Approved-by: Balasankar 'Balu' C <[email protected]>
Reviewed-by: Clemens Beck <[email protected]>
Co-authored-by: Ryan Egesdahl <[email protected]>

Author: balasankarc

config/projects/gitlab.rb

@@ -273,11 +273,25 @@
 package :rpm do
   vendor 'GitLab, Inc. <[email protected]>'
   signing_passphrase Gitlab::Util.get_env('GPG_PASSPHRASE')
+
+  # Enable XZ compression if selected
+  compress_xz = Gitlab::Util.get_env('COMPRESS_XZ') || 'false'
+  if compress_xz == 'true'
+    compression_type :xz
+    compression_level 6
+  end
 end
 
 package :deb do
   vendor 'GitLab, Inc. <[email protected]>'
   signing_passphrase Gitlab::Util.get_env('GPG_PASSPHRASE')
+
+  # Enable XZ compression if selected
+  compress_xz = Gitlab::Util.get_env('COMPRESS_XZ') || 'true'
+  if compress_xz == 'true'
+    compression_type :xz
+    compression_level 6
+  end
 end
 
 resources_path "#{Omnibus::Config.project_root}/resources"

doc/build/build_package.md

@@ -64,6 +64,20 @@ project's [Container Registry](https://gitlab.com/gitlab-org/gitlab-omnibus-buil
    export COMPILE_ASSETS=true
    ```
 
+1. By default, XZ compression is used to produce the final DEB package,
+   which reduces the package size by nearly 30% in comparison to Gzip, with
+   little to no increase in build time. However, the system's package
+   manager must also support the format. If your system's package manager does
+   not support XZ packages, set the `COMPRESS_XZ` environment variable to `false`:
+
+   ```shell
+   export COMPRESS_XZ=false
+   ```
+   
+   NOTE: This is feature is disabled by default on RPM platforms due to an
+   as-yet-unexplained increase in packaging time. It can be enabled by setting
+   the `COMPRESS_XZ` environment variable to `true`.
+
 1. Install the libraries and other dependencies:
 
    ```shell