Merge pull request #12257 from gitbutlerapp/GB-1049/add-linux-installer

feat(but-installer): make installer compatible with Linux

Author: slarse

.github/workflows/publish.yaml

@@ -67,13 +67,13 @@ jobs:
         run: pnpm build:desktop -- --mode ${{ env.vitemode }}
         env:
           SENTRY_RELEASE: ${{ env.version }}
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         name: Upload pnpm-store contents
         with:
           name: pnpm-store
           path: /home/runner/setup-pnpm/node_modules/.bin/store/v3
           retention-days: 7
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         name: Upload SvelteKit build output
         with:
           name: sveltekit-build
@@ -232,7 +232,7 @@ jobs:
             echo "artifact_suffix=" >> $GITHUB_ENV
           fi
       - name: Upload Artifacts
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         with:
           name: '${{ env.channel }}-${{ matrix.platform }}${{ env.artifact_suffix }}-${{ github.run_number }}'
           path: release/
@@ -247,7 +247,7 @@ jobs:
           cp target/release/gitbutler-git-askpass.exe tauri-aux-artifacts/
 
       - name: Upload Windows Aux Binary Artifacts
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         if: runner.os == 'Windows'
         with:
           name: '${{ env.channel }}-windows-aux-${{ github.run_number }}'
@@ -277,7 +277,7 @@ jobs:
         env:
           EVCODESIGND_PSK: ${{ secrets.EVCODESIGND_PSK }}
       - name: Upload signed artifacts
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         with:
           name: '${{ needs.build-tauri.outputs.channel }}-${{ matrix.platform }}-${{ github.run_number }}'
           path: release/
@@ -326,7 +326,7 @@ jobs:
         run: |
           Compress-Archive -Force -Path "release/${{ steps.set-path.outputs.msi_file }}" -DestinationPath "release/${{ steps.set-path.outputs.msi_file }}.zip"
       - name: Upload re-signed artifacts
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         with:
           name: '${{ needs.build-tauri.outputs.channel }}-${{ matrix.platform }}-${{ github.run_number }}'
           path: release/

.github/workflows/push.yaml

@@ -264,56 +264,116 @@ jobs:
       - name: 'cargo check'
         run: cargo check --workspace --all-targets --features windows
 
-  build-installer-macos:
+  build-installer:
     needs: changes
     if: ${{ needs.changes.outputs.but_installer == 'true' }}
     permissions:
       contents: read
-    runs-on: macos-14
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: macos-15 # [macOs, ARM64] - default target
+            artifact_id: macos-15-aarch64
+            target: ''
+          - platform: macos-15 # [macOs, x64] - cross-compile
+            artifact_id: macos-15-x86_64
+            target: x86_64-apple-darwin
+          - platform: ubuntu-22.04 # [linux, x64]
+            artifact_id: linux-x86_64
+            target: ''
+          - platform: ubuntu-22.04-arm # [linux, ARM64]
+            artifact_id: linux-aarch64
+            target: ''
+
+    runs-on: ${{ matrix.platform }}
+
     env:
       CARGO_TERM_COLOR: always
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
-      - name: Install Rust targets
+      - name: Set Cargo build target to ${{ matrix.target }}
+        shell: bash
+        if: matrix.target != ''
         run: |
-          rustup target add x86_64-apple-darwin
-          rustup target add aarch64-apple-darwin
+          echo "CARGO_BUILD_TARGET=${{ matrix.target }}" >> $GITHUB_ENV
+          rustup target add ${{ matrix.target }}
       - name: Rust Cache
         uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
-          shared-key: installer-macos
+          shared-key: installer
           save-if: ${{ github.ref == 'refs/heads/master' }}
       - name: Build installer for x86_64
-        run: cargo build --release -p but-installer --target x86_64-apple-darwin
-      - name: Build installer for aarch64
-        run: cargo build --release -p but-installer --target aarch64-apple-darwin
+        run: cargo build --release -p but-installer
       - name: Verify binaries
         run: |
-          test -x target/x86_64-apple-darwin/release/but-installer
-          test -x target/aarch64-apple-darwin/release/but-installer
-          echo "x86_64 binary:"
-          file target/x86_64-apple-darwin/release/but-installer
-          echo "aarch64 binary:"
-          file target/aarch64-apple-darwin/release/but-installer
-      - name: Upload x86_64 installer artifact
+          test -x target/${{matrix.target}}/release/but-installer
+          file target/${{matrix.target}}/release/but-installer
+      - name: Upload Artifacts
         uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         with:
-          name: 'but-installer-darwin-x86_64-${{ github.run_number }}'
-          path: target/x86_64-apple-darwin/release/but-installer
-          retention-days: 7
+          name: 'but-installer-${{ matrix.artifact_id }}-${{ github.run_number }}'
+          path: target/${{matrix.target}}/release/but-installer
           if-no-files-found: error
-      - name: Upload aarch64 installer artifact
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
-        with:
-          name: 'but-installer-darwin-aarch64-${{ github.run_number }}'
-          path: target/aarch64-apple-darwin/release/but-installer
           retention-days: 7
-          if-no-files-found: error
+
+  fetch-published-versions:
+    needs: build-installer
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: none
+    outputs:
+      release_version: ${{ steps.fetch.outputs.release_version }}
+      nightly_version: ${{ steps.fetch.outputs.nightly_version }}
+    steps:
+      - name: Fetch latest release and nightly versions
+        id: fetch
+        run: |
+          echo "release_version=$(curl -s https://app.gitbutler.com/releases | jq -r .version)" >> $GITHUB_OUTPUT
+          echo "nightly_version=$(curl -s https://app.gitbutler.com/releases/nightly | jq -r .version)" >> $GITHUB_OUTPUT
+
+  validate-installer:
+    needs:
+      - build-installer
+      - fetch-published-versions
+    permissions:
+      contents: none
+    env:
+      LATEST_RELEASE_VERSION: ${{ needs.fetch-published-versions.outputs.release_version }}
+      LATEST_NIGHTLY_VERSION: ${{ needs.fetch-published-versions.outputs.nightly_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: macos-15 # [macOs, ARM64] - default target
+            artifact_id: macos-15-aarch64
+          - platform: macos-15 # [macOs, x64] - cross-compile
+            artifact_id: macos-15-x86_64
+          - platform: ubuntu-22.04 # [linux, x64]
+            artifact_id: linux-x86_64
+          - platform: ubuntu-22.04-arm # [linux, ARM64]
+            artifact_id: linux-aarch64
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Download ${{ matrix.artifact_id }} installer
+        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+        with:
+          name: 'but-installer-${{ matrix.artifact_id }}-${{ github.run_number }}'
+          path: .
+      - run: chmod +x ./but-installer
+      - name: Install release
+        run: ./but-installer
+      - name: Validate release version
+        run: but --version | grep "but $LATEST_RELEASE_VERSION"
+      - name: Install nightly
+        run: ./but-installer nightly
+      - name: Validate nightly version
+        run: but --version | grep "but $LATEST_NIGHTLY_VERSION"
 
   publish-installer:
-    needs: build-installer-macos
+    needs: build-installer
     if: ${{ github.ref == 'refs/heads/master' }}
     runs-on: ubuntu-latest
     permissions:
@@ -322,23 +382,29 @@ jobs:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
-      - name: Download x86_64 installer
+      - name: Download macOS x86_64 installer
+        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+        with:
+          name: 'but-installer-macos-15-x86_64-${{ github.run_number }}'
+          path: s3-upload/macos/x86_64
+      - name: Download macOS aarch64 installer
+        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+        with:
+          name: 'but-installer-macos-15-aarch64-${{ github.run_number }}'
+          path: s3-upload/macos/aarch64
+      - name: Download Linux x86_64 installer
         uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
         with:
-          name: 'but-installer-darwin-x86_64-${{ github.run_number }}'
-          path: installer-artifacts/darwin-x86_64
-      - name: Download aarch64 installer
+          name: 'but-installer-linux-x86_64-${{ github.run_number }}'
+          path: s3-upload/linux/x86_64
+      - name: Download Linux aarch64 installer
         uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
         with:
-          name: 'but-installer-darwin-aarch64-${{ github.run_number }}'
-          path: installer-artifacts/darwin-aarch64
-      - name: Prepare S3 payload
+          name: 'but-installer-linux-aarch64-${{ github.run_number }}'
+          path: s3-upload/linux/aarch64
+      - name: Make binaries executable
         run: |
-          mkdir -p s3-upload/macos/x86_64
-          mkdir -p s3-upload/macos/aarch64
-          cp installer-artifacts/darwin-x86_64/but-installer s3-upload/macos/x86_64/but-installer
-          cp installer-artifacts/darwin-aarch64/but-installer s3-upload/macos/aarch64/but-installer
-          chmod +x s3-upload/macos/*/but-installer
+          find ./s3-upload -name 'but-installer' | xargs chmod +x
       - name: Upload to S3
         uses: shallwefootball/s3-upload-action@4350529f410221787ccf424e50133cbc1b52704e # master
         with:
@@ -365,7 +431,7 @@ jobs:
       - rust-test-tauri
       - rust-lint
       - cargo-doc
-      - build-installer-macos
+      - build-installer
     runs-on: ubuntu-latest
     env:
       CARGO_TERM_COLOR: always
@@ -431,7 +497,7 @@ jobs:
       - name: run playwright tests
         run: pnpm exec turbo run test:ct
         if: ${{ github.ref != 'refs/heads/master' }}
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         if: ${{ !cancelled() }}
         with:
           name: playwright-report

.github/workflows/test-e2e-blackbox.yml

@@ -64,7 +64,7 @@ jobs:
         if: ${{ github.ref != 'refs/heads/master' }}
         run: xvfb-run pnpm test:e2e:blackbox
 
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         if: failure()
         with:
           name: WebdriverIO Artifacts

.github/workflows/test-e2e-playwright.yml

@@ -76,7 +76,7 @@ jobs:
       - name: Run Playwright tests
         run: pnpm exec turbo run test:e2e:playwright
         if: ${{ github.ref != 'refs/heads/master' }}
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         if: ${{ !cancelled() }}
         with:
           name: playwright-report

Cargo.lock

@@ -40,3 +40,7 @@ base64 = "0.22.1"
 [target.'cfg(target_os = "macos")'.dependencies]
 # For removing quarantine attribute on macOS
 xattr = "1.6.1"
+
+[target.'cfg(target_os = "linux")'.dependencies]
+# I couldn't make it work without the ssl feature enabled, it doesn't dynamically link to libssl without it so https just doesn't work
+curl = { version = "0.4.49", default-features = false, features = ["ssl"] }

crates/but-installer/Cargo.toml

@@ -150,14 +150,12 @@ impl InstallerConfig {
         let os = env::consts::OS;
         let arch = env::consts::ARCH;
 
-        if os != "macos" {
-            bail!("This installer currently only supports macOS. Your OS: {}", os);
-        }
-
-        let platform = match arch {
-            "x86_64" => "darwin-x86_64",
-            "aarch64" => "darwin-aarch64",
-            _ => bail!("Unsupported architecture: {}", arch),
+        let platform = match (os, arch) {
+            ("macos", "aarch64") => "darwin-aarch64",
+            ("macos", "x86_64") => "darwin-x86_64",
+            ("linux", "aarch64") => "linux-aarch64",
+            ("linux", "x86_64") => "linux-x86_64",
+            (os, arch) => bail!("unsupported OS or architecture: {os} {arch}"),
         };
 
         Ok(Self {