Wave XLR MK.2, 48 V phantom power, and a mixing matrix with per-mix outputs

.github/workflows/release.yml

@@ -0,0 +1,220 @@
+name: Release
+
+# Tag-driven semver, adapted from the Stream Deck plugin's release flow.
+# That repo computes versions with semantic-release from Angular commit
+# messages; this one writes prose commit subjects, which semantic-release
+# reads as "never release". So the version is the tag -- push v1.2.3 and
+# this builds the release objects -- and everything downstream of the
+# version (gate on the suite, build artifacts, publish a Release, point the
+# PKGBUILD at it and publish to AUR) is as automatic as the plugin's.
+#
+#   git tag v1.2.3 && git push <remote> v1.2.3
+#
+# This workflow is the only one that creates Releases and tags carry no other
+# automation, so one tag push can never produce two Releases. The AUR job
+# no-ops quietly when the AUR_SSH_PRIVATE_KEY secret is absent (forks).
+
+on:
+  push:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+*"]
+  # Buildable on demand so the artifact steps can be exercised without
+  # spending a version number; a dispatch run uploads workflow artifacts
+  # but publishes no Release.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Gate on the suite
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install libusb
+        run: sudo apt-get update -qq && sudo apt-get install -y -qq libusb-1.0-0
+      - name: Run unit tests
+        run: python -m unittest discover -s tests -t . -v
+      - name: Byte-compile every module
+        run: python -m compileall -q wavexlr tests
+
+  build:
+    name: Build release objects
+    needs: [test]
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Resolve version
+        id: version
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/v* ]]; then
+            echo "version=${GITHUB_REF#refs/tags/v}" >> "$GITHUB_OUTPUT"
+          else
+            echo "version=0.0.0-dev.${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Source tarball
+        run: |
+          V="${{ steps.version.outputs.version }}"
+          git archive --format=tar.gz --prefix="openwave-${V}/" \
+            -o "openwave-${V}.tar.gz" HEAD
+
+      # A .deb built on the runner installs into the runner distribution's
+      # own site-packages path (the Makefile asks the interpreter), which is
+      # the right path for the systems that will install the .deb. Depends
+      # mirrors install.sh's apt list; python3-xlib is Recommends, matching
+      # its strictly-optional status.
+      - name: Debian package
+        run: |
+          V="${{ steps.version.outputs.version }}"
+          PKG="openwave_${V}_all"
+          # SITEPKG pinned: the Makefile asks the interpreter, and Ubuntu's
+          # system python answers /usr/local/... first -- the right path for
+          # a live install on that machine, the wrong one inside a package.
+          make install DESTDIR="$PWD/$PKG" PREFIX=/usr \
+            SITEPKG=/usr/lib/python3/dist-packages
+          mkdir -p "$PKG/DEBIAN"
+          cat > "$PKG/DEBIAN/control" <<EOF
+          Package: openwave
+          Version: ${V}
+          Section: sound
+          Priority: optional
+          Architecture: all
+          Depends: python3 (>= 3.10), python3-gi, gir1.2-gtk-4.0, gir1.2-adw-1, libadwaita-1-0, libusb-1.0-0, pipewire
+          Recommends: python3-xlib
+          Maintainer: OpenWave contributors
+          Homepage: https://github.com/rikkichy/openwave
+          Description: The audio mixing matrix for Linux
+           Per-app mixes with per-mix outputs, plus native control of Elgato
+           Wave hardware - the Wave XLR interface (original and MK.2/XLR
+           Dock) and the Wave:3 microphone.
+          EOF
+          dpkg-deb --build --root-owner-group "$PKG"
+
+      # noarch rpm from the spec: module under /usr/share/openwave with
+      # PYTHONPATH launchers, so one rpm serves every Fedora python.
+      - name: RPM package
+        run: |
+          V="${{ steps.version.outputs.version }}"
+          RV="${V//-/\~}"   # rpm Version forbids '-'; ~ is its pre-release
+          sudo apt-get install -y -qq rpm
+          mkdir -p rpmbuild/{SOURCES,SPECS}
+          cp "openwave-${V}.tar.gz" rpmbuild/SOURCES/
+          sed -e "s/@VERSION@/${RV}/" -e "s/@SRCVER@/${V}/" \
+            packaging/rpm/openwave.spec > rpmbuild/SPECS/openwave.spec
+          rpmbuild --define "_topdir $PWD/rpmbuild" \
+            --define "dist %{nil}" -bb rpmbuild/SPECS/openwave.spec
+          cp rpmbuild/RPMS/noarch/openwave-*.rpm .
+
+      - name: Checksums
+        run: sha256sum openwave-*.tar.gz openwave_*.deb openwave-*.rpm > sha256sums.txt
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-objects
+          path: |
+            openwave-*.tar.gz
+            openwave_*.deb
+            openwave-*.rpm
+            sha256sums.txt
+
+  publish:
+    name: Publish Release
+    needs: [build]
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: release-objects
+      - name: Create Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${GITHUB_REF#refs/tags/}" \
+            --repo "${GITHUB_REPOSITORY}" \
+            --title "OpenWave ${GITHUB_REF#refs/tags/v}" \
+            --generate-notes \
+            openwave-*.tar.gz openwave_*.deb sha256sums.txt
+
+  aur:
+    name: Publish to AUR
+    needs: [publish]
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    container: archlinux:base-devel
+    timeout-minutes: 10
+    permissions:
+      contents: write
+    steps:
+      - name: Install tools
+        run: pacman -Syu --noconfirm git openssh
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: release-objects
+
+      # The artifact tarball IS the file the Release serves, so its checksum
+      # is the one the PKGBUILD must pin. The old manual flow bumped pkgver
+      # without touching sha256sums, which could only ever be stale: the
+      # tarball it points at does not exist until this workflow publishes it.
+      - name: Point the PKGBUILD at this release
+        run: |
+          V="${GITHUB_REF#refs/tags/v}"
+          SUM=$(sha256sum "openwave-${V}.tar.gz" | cut -d' ' -f1)
+          sed -i "s/^pkgver=.*/pkgver=${V}/" PKGBUILD
+          sed -i "s/^pkgrel=.*/pkgrel=1/" PKGBUILD
+          sed -i "s/^sha256sums=.*/sha256sums=('${SUM}')/" PKGBUILD
+
+      - name: Commit the PKGBUILD back
+        run: |
+          git config --global --add safe.directory "$PWD"
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add PKGBUILD
+          git diff --cached --quiet || git commit -m "Point the PKGBUILD at v${GITHUB_REF#refs/tags/v}"
+          git push
+
+      - name: Push to AUR
+        env:
+          AUR_SSH_PRIVATE_KEY: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
+          AUR_USERNAME: ${{ secrets.AUR_USERNAME }}
+          AUR_EMAIL: ${{ secrets.AUR_EMAIL }}
+        run: |
+          if [ -z "$AUR_SSH_PRIVATE_KEY" ]; then
+            echo "AUR_SSH_PRIVATE_KEY not set; skipping AUR publish."
+            exit 0
+          fi
+          V="${GITHUB_REF#refs/tags/v}"
+          mkdir -p ~/.ssh
+          echo "$AUR_SSH_PRIVATE_KEY" > ~/.ssh/aur
+          chmod 600 ~/.ssh/aur
+          ssh-keyscan -t ed25519,rsa aur.archlinux.org > ~/.ssh/known_hosts 2>&1 || true
+          export GIT_SSH_COMMAND="ssh -i ~/.ssh/aur -o StrictHostKeyChecking=accept-new"
+          git config --global user.name "$AUR_USERNAME"
+          git config --global user.email "$AUR_EMAIL"
+          git config --global --add safe.directory '*'
+
+          git clone ssh://aur@aur.archlinux.org/openwave.git aur-repo
+          cp PKGBUILD aur-repo/PKGBUILD
+          useradd -m builder
+          chown -R builder:builder aur-repo
+          cd aur-repo
+          su builder -c "makepkg --printsrcinfo" > .SRCINFO
+          git add PKGBUILD .SRCINFO
+          git commit -m "Update to v${V}"
+          git push

.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  unit:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # 3.10 is the floor the README states; the newest catches deprecations
+        # early. Nothing between them is interesting enough to pay for.
+        python: ["3.10", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      # wavexlr/device.py loads libusb through ctypes at import time, so the
+      # runner needs the shared library even though no device is present. It
+      # is the only system dependency the suite has.
+      - name: Install libusb
+        run: sudo apt-get update -qq && sudo apt-get install -y -qq libusb-1.0-0
+
+      # No Python dependencies on purpose. The suite covers the backend modules,
+      # which import neither GTK nor libusb, so it runs on a bare runner with
+      # no audio server, no PipeWire and no hardware. Anything needing those
+      # belongs in a manual check, not here.
+      - name: Run unit tests
+        run: python -m unittest discover -s tests -t . -v
+
+      - name: Byte-compile every module
+        run: python -m compileall -q wavexlr tests

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 *.pyc
 *.pyo
 .vscode/
+docs/comparison.md