orb-ui: sound files in debian package (#220)

orb-ui: sound files

Now that only orb-ui handles the sounds, we can include them in the deb package

.gitattributes

@@ -0,0 +1 @@
+*.wav filter=lfs diff=lfs merge=lfs -text

.github/workflows/check-sound-files.yaml

@@ -0,0 +1,22 @@
+name: Check Sound Files
+
+on:
+  push:
+    paths:
+      - 'orb-ui/sound/assets/**'
+      - '.github/workflows/check-sound-files.yaml'
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # pin@v3
+        with:
+          lfs: true
+      - run: sudo apt-get install -y sox
+      - name: Check sound files
+        run: |
+          bash ./orb-ui/sound/utils/check_sounds.sh orb-ui/sound/assets/
+          # ensure error code is 0
+          exit $?

.github/workflows/rust-ci.yaml

@@ -158,6 +158,7 @@ jobs:
       - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # pin@v3
         with:
           token: ${{ secrets.GIT_HUB_TOKEN }}
+          lfs: true
       - uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # pin@v27
         with:
           github_access_token: ${{ secrets.GIT_HUB_TOKEN }}

orb-ui/Cargo.toml

@@ -49,6 +49,9 @@ chrono = "0.4.35"
 
 [package.metadata.deb]
 maintainer-scripts = "debian/"
+assets = [
+  ["sound/assets/*.wav", "/home/worldcoin/data/sounds/", "644"]
+]
 systemd-units = [
   { unit-name = "worldcoin-ui" },
 ]

orb-ui/sound/utils/README.md

@@ -0,0 +1,9 @@
+# Sound utils
+
+## `check_sounds.sh`
+
+Ensure that all sounds are `.wav` files with 16-bit/sample.
+
+```shell
+$ bash ./check_sounds.sh ../assets/
+```