Merge branch 'main' into feature/plasma-shortcut-activation

Author: webenefits

.github/workflows/nightly.yml

@@ -12,6 +12,9 @@ jobs:
   nightly:
     name: Build and Publish Nightly
     runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      release_tag: ${{ steps.create_release.outputs.tag }}
 
     steps:
       - name: Checkout code
@@ -33,7 +36,13 @@ jobs:
             portaudio19-dev \
             python3-dev \
             libgirepository1.0-dev \
-            pkg-config
+            libgirepository-2.0-dev \
+            pkg-config \
+            libcairo2-dev \
+            gobject-introspection \
+            gir1.2-gtk-3.0 \
+            gir1.2-appindicator3-0.1 \
+            gir1.2-ibus-1.0
 
       - name: Install build dependencies
         run: |
@@ -80,6 +89,11 @@ jobs:
           done
           ls -la dist/
 
+      - name: Build AppImage (x86_64)
+        run: |
+          bash packaging/appimage/build.sh dist/*.whl "${{ steps.version.outputs.version }}" dist
+          ls -la dist/*.AppImage
+
       - name: Cleanup old nightly releases
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -166,6 +180,14 @@ jobs:
           curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash
           \`\`\`
 
+          #### AppImage (no install, no root)
+          Download the \`.AppImage\` matching your CPU (\`x86_64\` or \`aarch64\`) below:
+          \`\`\`bash
+          chmod +x Vocalinux-${{ steps.version.outputs.version }}-x86_64.AppImage
+          ./Vocalinux-${{ steps.version.outputs.version }}-x86_64.AppImage
+          \`\`\`
+          Requires \`xdotool\`/\`wtype\`/\`ydotool\` on the host for text injection, same as the PyPI install path.
+
           ---
 
           ### Build Information
@@ -184,6 +206,8 @@ jobs:
 
           - **\`vocalinux-${{ steps.version.outputs.version }}-py3-none-any.whl\`** - Python wheel (recommended)
           - **\`vocalinux-${{ steps.version.outputs.version }}.tar.gz\`** - Source distribution
+          - **\`Vocalinux-${{ steps.version.outputs.version }}-x86_64.AppImage\`** - Self-contained, no install (Intel/AMD)
+          - **\`Vocalinux-${{ steps.version.outputs.version }}-aarch64.AppImage\`** - Self-contained, no install (ARM64, added shortly after this release is published)
 
           ---
 
@@ -202,26 +226,85 @@ jobs:
           echo "notes_file=/tmp/release_notes.md" >> $GITHUB_OUTPUT
 
       - name: Create nightly release
+        id: create_release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           # Create release with dated tag: nightly-2025-02-11
           RELEASE_TAG="nightly-$(date +%Y-%m-%d)"
-          
+
           # If a release for today already exists, delete it first
           gh release delete "$RELEASE_TAG" --yes --repo ${{ github.repository }} 2>/dev/null || true
           git push origin :refs/tags/"$RELEASE_TAG" 2>/dev/null || true
           git tag -d "$RELEASE_TAG" 2>/dev/null || true
-          
+
           gh release create "$RELEASE_TAG" \
             --title "Nightly Build - ${{ steps.version.outputs.version }}" \
             --notes-file ${{ steps.release_notes.outputs.notes_file }} \
             --prerelease \
             dist/*
 
+          echo "tag=${RELEASE_TAG}" >> "$GITHUB_OUTPUT"
+
       - name: Upload artifacts (backup)
         uses: actions/upload-artifact@v4
         with:
           name: vocalinux-nightly-${{ steps.version.outputs.version }}
           path: dist/
           retention-days: 7
+
+  nightly-appimage-arm64:
+    name: Build and Attach Nightly AppImage (aarch64)
+    runs-on: ubuntu-24.04-arm
+    needs: nightly
+    if: needs.nightly.result == 'success'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            portaudio19-dev \
+            python3-dev \
+            libgirepository1.0-dev \
+            libgirepository-2.0-dev \
+            pkg-config \
+            libcairo2-dev \
+            gobject-introspection \
+            gir1.2-gtk-3.0 \
+            gir1.2-appindicator3-0.1 \
+            gir1.2-ibus-1.0
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel build
+
+      - name: Build package
+        run: |
+          python -m build
+          ls -la dist/
+
+      - name: Build AppImage (aarch64)
+        run: |
+          bash packaging/appimage/build.sh dist/*.whl "${{ needs.nightly.outputs.version }}" dist
+          ls -la dist/*.AppImage
+
+      - name: Attach to nightly release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload "${{ needs.nightly.outputs.release_tag }}" \
+            dist/*.AppImage \
+            --repo ${{ github.repository }} \
+            --clobber

.github/workflows/release.yml

@@ -29,6 +29,21 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: 'pip'
 
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            portaudio19-dev \
+            python3-dev \
+            libgirepository1.0-dev \
+            libgirepository-2.0-dev \
+            pkg-config \
+            libcairo2-dev \
+            gobject-introspection \
+            gir1.2-gtk-3.0 \
+            gir1.2-appindicator3-0.1 \
+            gir1.2-ibus-1.0
+
       - name: Install build dependencies
         run: |
           python -m pip install --upgrade pip
@@ -59,13 +74,19 @@ jobs:
           echo "Built packages:"
           ls -la dist/
 
+      - name: Build AppImage (x86_64)
+        run: |
+          bash packaging/appimage/build.sh dist/*.whl "${{ steps.get_version.outputs.VERSION }}" dist
+          ls -la dist/*.AppImage
+
       - name: Create Release
         id: create_release
         uses: softprops/action-gh-release@v2
         with:
           files: |
             dist/*.whl
             dist/*.tar.gz
+            dist/*.AppImage
           generate_release_notes: true
           draft: false
           prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
@@ -103,9 +124,77 @@ jobs:
             yay -S vocalinux
             ```
 
+            ### AppImage (no install, no root)
+            Download the `.AppImage` matching your CPU (`x86_64` or `aarch64`, the latter attached
+            shortly after this release is published) below:
+            ```bash
+            chmod +x Vocalinux-${{ steps.get_version.outputs.VERSION }}-x86_64.AppImage
+            ./Vocalinux-${{ steps.get_version.outputs.VERSION }}-x86_64.AppImage
+            ```
+            Still requires `xdotool`/`wtype`/`ydotool` on the host for text injection, same as the PyPI path.
+
             ---
             See [CHANGELOG](https://github.com/jatinkrmalik/vocalinux/releases) for detailed changes.
 
+  build-appimage-arm64:
+    name: Build and Attach AppImage (aarch64)
+    needs: build-and-release
+    runs-on: ubuntu-24.04-arm
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            portaudio19-dev \
+            python3-dev \
+            libgirepository1.0-dev \
+            libgirepository-2.0-dev \
+            pkg-config \
+            libcairo2-dev \
+            gobject-introspection \
+            gir1.2-gtk-3.0 \
+            gir1.2-appindicator3-0.1 \
+            gir1.2-ibus-1.0
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build wheel setuptools
+
+      - name: Extract version from tag
+        id: get_version
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Build package
+        run: |
+          python -m build
+          ls -la dist/
+
+      - name: Build AppImage (aarch64)
+        run: |
+          bash packaging/appimage/build.sh dist/*.whl "${{ steps.get_version.outputs.VERSION }}" dist
+          ls -la dist/*.AppImage
+
+      - name: Attach to release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload "${{ github.ref_name }}" \
+            dist/*.AppImage \
+            --repo ${{ github.repository }} \
+            --clobber
+
   publish-pypi:
     name: Publish to PyPI
     needs: build-and-release

.github/workflows/unified-pipeline.yml

@@ -170,6 +170,69 @@ jobs:
           files: coverage.xml
           fail_ci_if_error: false
 
+  appimage-smoke-test:
+    name: 📦 Build AppImage (smoke test, ${{ matrix.arch }})
+    runs-on: ${{ matrix.runner }}
+    needs: changes
+    if: needs.changes.outputs.python == 'true'
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - arch: x86_64
+            runner: ubuntu-latest
+          - arch: aarch64
+            runner: ubuntu-24.04-arm
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            xdotool \
+            gir1.2-appindicator3-0.1 \
+            gir1.2-ibus-1.0 \
+            libcairo2-dev \
+            pkg-config \
+            python3-dev \
+            libgirepository1.0-dev \
+            gobject-introspection \
+            libcairo-gobject2 \
+            gir1.2-gtk-3.0 \
+            portaudio19-dev
+
+      - name: Install GObject introspection dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y gir1.2-glib-2.0 libgirepository-2.0-dev pkg-config
+
+      - name: Build wheel
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+          ls -la dist/
+
+      - name: Build AppImage
+        run: |
+          VERSION=$(grep -oP '__version__\s*=\s*"\K[^"]+' src/vocalinux/version.py)
+          WHEEL=$(ls dist/*.whl)
+          bash packaging/appimage/build.sh "$WHEEL" "$VERSION" dist
+          ls -la dist/*.AppImage
+
+      - name: Upload AppImage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: vocalinux-appimage-${{ matrix.arch }}
+          path: dist/*.AppImage
+          retention-days: 7
+
   web-build:
     name: 🌐 Build Website
     runs-on: ubuntu-latest

docs/INSTALL.md

@@ -629,11 +629,30 @@ Model names with more language and size variety can be found in [VOSK Models](ht
 **Symptom:** Tray icon missing or generic
 
 **Solution:**
+
+On GNOME (including Fedora Workstation and Ubuntu), AppIndicator support is often
+disabled until you install and enable the tray extension:
+
 ```bash
-# Refresh icon cache
-gtk-update-icon-cache -f -t ~/.local/share/icons/hicolor
+# Debian/Ubuntu
+sudo apt install gnome-shell-extension-appindicator
+
+# Fedora
+sudo dnf install gnome-shell-extension-appindicator
+
+# Arch
+sudo pacman -S gnome-shell-extension-appindicator
 
-# Restart the application
+# Then enable (Extensions app, or):
+gnome-extensions enable appindicatorsupport@rgcjonas.gmail.com
+# Log out and back in if the icon still does not appear
+```
+
+Also refresh the icon cache and restart Vocalinux:
+
+```bash
+gtk-update-icon-cache -f -t ~/.local/share/icons/hicolor
+vocalinux --debug
 ```
 
 ## Uninstallation

install.sh

@@ -1484,11 +1484,17 @@ install_system_dependencies() {
     fi
 
     # Define package names for different distributions
-    # Determine the correct GObject Introspection dev package for Ubuntu-family distros
-    # Ubuntu 24.04+ and Pop!_OS Cosmic+ ship libgirepository-2.0-dev instead of 1.0
+    # GObject Introspection / GLib headers for building PyGObject and friends.
+    # Prefer libgirepository-2.0-dev when available (Ubuntu 24.04+, Pop!_OS Cosmic+,
+    # Debian 13+). When both 1.0 and 2.0 packages exist, install both: 2.0 provides
+    # the modern GLib GI headers that pip builds need, while 1.0 still pulls
+    # gobject-introspection tooling. Older distros that only ship 1.0 keep that.
+    # See #571 (installer previously kept 1.0 whenever apt-cache still listed it).
     local GI_DEV_PKG="libgirepository1.0-dev"
     if apt-cache show libgirepository-2.0-dev &>/dev/null 2>&1; then
-        if ! apt-cache show libgirepository1.0-dev &>/dev/null 2>&1; then
+        if apt-cache show libgirepository1.0-dev &>/dev/null 2>&1; then
+            GI_DEV_PKG="libgirepository-2.0-dev libgirepository1.0-dev"
+        else
             GI_DEV_PKG="libgirepository-2.0-dev"
         fi
     fi