Create installer packages

Author: spoorcc

.devcontainer/Dockerfile

@@ -9,6 +9,19 @@ RUN apt-get update && apt-get install --no-install-recommends -y \
     subversion=1.14.1-3+deb11u2 && \
     rm -rf /var/lib/apt/lists/*
 
+# Install ruby gem FPM for packaging
+RUN apt-get update && \
+    apt-get install --no-install-recommends -y \
+        ruby=1:2.7+2 \
+        ruby-dev=1:2.7+2 \
+        build-essential \
+        rpm=4.16.1.2+dfsg1-3 \
+        git \
+        curl \
+        ca-certificates && \
+    gem install --no-document fpm && \
+    rm -rf /var/lib/apt/lists/*
+
 WORKDIR /workspaces/dfetch
 
 # Add a non-root user (dev)

.github/workflows/build.yml

@@ -34,6 +34,17 @@ jobs:
         with:
           python-version: '3.13'
 
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2   # or any version you need
+
+      - name: Install fpm
+        run: |
+          echo "$(ruby -e 'puts File.join(Gem.user_dir, "bin")')" >> $GITHUB_PATH
+          gem install --no-document fpm
+          fpm --version
+
       - name: ccache
         uses: hendrikmuhs/ccache-action@5ebbd400eff9e74630f759d94ddd7b6c26299639 # v1.2
         if: ${{ matrix.platform != 'windows-latest' }}
@@ -57,8 +68,10 @@ jobs:
           NUITKA_CACHE_DIR_CLCACHE: ${{ github.workspace }}\.clcache
           NUITKA_CCACHE_BINARY: /usr/bin/ccache
         run: |
+          fpm --version
           pip install .[build]
           python script/build.py
+          python script/package.py
 
       - name: Store the distribution packages
         uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
@@ -85,27 +98,27 @@ jobs:
     - name: Prepare binary
       if: matrix.platform == 'ubuntu-latest'
       run: |
+        ls -la .
         binary=$(ls dfetch-*-x86_64)
         ln -sf "$binary" dfetch
         chmod +x dfetch
-        ls -la .
       shell: bash
 
     - name: Prepare binary
       if: matrix.platform == 'macos-latest'
       run: |
+        ls -la .
         binary=$(ls dfetch-*-osx)
         ln -sf "$binary" dfetch
         chmod +x dfetch
-        ls -la .
       shell: bash
 
     - name: Prepare binary on Windows
       if: matrix.platform == 'windows-latest'
       run: |
+        Get-ChildItem
         $binary = Get-ChildItem dfetch-*.exe | Select-Object -First 1
         Copy-Item $binary -Destination dfetch.exe -Force
-        Get-ChildItem
       shell: pwsh
 
     - run: ./dfetch init

pyproject.toml

@@ -190,8 +190,8 @@ reportMissingModuleSource = false
 pythonVersion = "3.9"
 
 [tool.nuitka]
-mode = "onefile" # Switch this between standalone and onefile as needed
-# jobs = "4" # Can be used to reduce memory usage, in case of compilation issues
+mode = "standalone" # Switch this between standalone and onefile as needed
+jobs = "2" # Can be used to reduce memory usage, in case of compilation issues
 # Enable below for debugging
 # show-progress = true
 assume-yes-for-downloads = true

script/build.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 """This script builds the dfetch executable using Nuitka."""
+import os
+import shutil
 import subprocess  # nosec
 import sys
 import tomllib as toml
@@ -68,5 +70,18 @@ def parse_option(
 
 command.append("dfetch")
 
+print("Python PATH:", os.environ.get("PATH"))
+print("Python GITHUB PATH:", os.environ.get("GITHUB_PATH"))
+print("Python GITHUB ENV:", os.environ.get("GITHUB_ENV"))
+subprocess.check_call(["where" if os.name == "nt" else "which", "fpm"])
+
+fpm_path = shutil.which("fpm")
+
+if not fpm_path:
+    print("Error: fpm not found in PATH.")
+    sys.exit(1)
+
+subprocess.check_call([fpm_path, "--version"])  # nosec
+
 print(command)
 subprocess.check_call(command)  # nosec

script/package.py

@@ -0,0 +1,143 @@
+#!/usr/bin/env python3
+"""This script packages the dfetch build directory into OS-specific installers using fpm."""
+import subprocess
+import sys
+from pathlib import Path
+
+from dfetch import __version__
+
+# Configuration
+BUILD_DIR = Path("build", "dfetch.dist")
+OUTPUT_DIR = Path("build", "dfetch-package")
+PACKAGE_NAME = "dfetch"
+INSTALL_PREFIX = "/opt/dfetch"  # Where the files will be installed on Linux/macOS
+MAINTAINER = "DFetch Team <dfetch@spoor.cc>"
+DESCRIPTION = (
+    "DFetch: A vendoring tool for fetching and managing external dependencies."
+)
+URL = "https://github.com/dfetch-org/dfetch"
+LICENSE = "MIT"
+
+
+def run_command(command):
+    """Run a system command and handle errors."""
+    print("Running:", " ".join(command))
+    subprocess.check_call(command)
+
+
+def package_linux() -> None:
+    """Package the build directory into .deb and .rpm installers."""
+    for target in ("deb", "rpm"):
+        output = f"{OUTPUT_DIR}/{PACKAGE_NAME}_{__version__}.{target}"
+        cmd = [
+            "fpm",
+            "-s",
+            "dir",
+            "-t",
+            target,
+            "-n",
+            PACKAGE_NAME,
+            "-v",
+            __version__,
+            "-C",
+            str(BUILD_DIR),
+            "--prefix",
+            INSTALL_PREFIX,
+            "--description",
+            DESCRIPTION,
+            "--maintainer",
+            MAINTAINER,
+            "--url",
+            URL,
+            "--license",
+            LICENSE,
+            "-p",
+            output,
+            ".",
+        ]
+        run_command(cmd)
+
+
+def package_macos() -> None:
+    """Package the build directory into a .pkg installer for macOS."""
+    cmd = [
+        "fpm",
+        "-s",
+        "dir",
+        "-t",
+        "osxpkg",
+        "-n",
+        PACKAGE_NAME,
+        "-v",
+        __version__,
+        "-C",
+        str(BUILD_DIR),
+        "--prefix",
+        INSTALL_PREFIX,
+        "--description",
+        DESCRIPTION,
+        "--maintainer",
+        MAINTAINER,
+        "--url",
+        URL,
+        "--license",
+        LICENSE,
+        "-p",
+        f"{OUTPUT_DIR}/{PACKAGE_NAME}_{__version__}.pkg",
+        ".",
+    ]
+    run_command(cmd)
+
+
+def package_windows() -> None:
+    """Package the build directory into a .msi installer for Windows."""
+    run_command(["cd"])
+    run_command(["fpm", "--version"])
+    cmd = [
+        "fpm",
+        "-s",
+        "dir",
+        "-t",
+        "msi",
+        "--verbose",
+        "-n",
+        PACKAGE_NAME,
+        "-v",
+        __version__,
+        "-C",
+        str(BUILD_DIR),
+        "--description",
+        DESCRIPTION,
+        "--manufacturer",
+        MAINTAINER,
+        "--url",
+        URL,
+        "--license",
+        LICENSE,
+        "-p",
+        f"{OUTPUT_DIR}/{PACKAGE_NAME}_{__version__}.msi",
+        ".",
+    ]
+    run_command(cmd)
+
+
+def main() -> None:
+    """Main packaging function."""
+    if not BUILD_DIR.exists():
+        print(f"Error: Build directory {BUILD_DIR} does not exist. Run build.py first.")
+        sys.exit(1)
+    OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
+
+    if sys.platform.startswith("linux"):
+        package_linux()
+    elif sys.platform.startswith("darwin"):
+        package_macos()
+    elif sys.platform.startswith("win"):
+        package_windows()
+    else:
+        print(f"Unsupported platform: {sys.platform}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()