ci: use Xvfb and pulseaudio

Author: florianvazelle

.github/actions/setup-godot/action.yml

@@ -0,0 +1,35 @@
+name: Setup Godot
+description: Setup Godot dependencies.
+runs:
+  using: "composite"
+  steps:
+
+    - name: Installing Linux dependencies
+      if: ${{ runner.os == 'Linux' }}
+      shell: bash
+      run: sudo apt-get install -y pulseaudio xvfb x11-xserver-utils mesa-vulkan-drivers
+
+    - name: Starting X11 server on :0
+      if: ${{ runner.os == 'Linux' }}
+      shell: bash
+      run: xset -q || /bin/bash -c "sudo Xvfb -ac :0 -screen 0 1920x1080x24 > /dev/null 2>&1 &"
+      env:
+        DISPLAY: ":0"
+
+    - name: Check that X11 server is running
+      if: ${{ runner.os == 'Linux' }}
+      uses: nick-fields/retry@v2
+      with:
+        timeout_minutes: 1
+        max_attempts: 5
+        command: /bin/bash -c "xset -q > /dev/null 2>&1"
+      env:
+        DISPLAY: ":0"
+
+    - name: Starting dummy sound device
+      if: ${{ runner.os == 'Linux' }}
+      uses: nick-fields/retry@v2
+      with:
+        timeout_minutes: 1
+        max_attempts: 3
+        command: pulseaudio --check || pulseaudio -D

.github/workflows/release-packaging.yml

@@ -44,6 +44,9 @@ jobs:
       - name: Load dotenv
         run: just ci-load-dotenv
 
+      - name: Setup Godot dependencies
+        uses: ./.github/actions/setup-godot
+
       - name: Export
         run: just export
 
@@ -68,6 +71,9 @@ jobs:
       - name: Load dotenv
         run: just ci-load-dotenv
 
+      - name: Setup Godot dependencies
+        uses: ./.github/actions/setup-godot
+
       - name: Export
         run: just export-web
 

Justfile

@@ -129,7 +129,12 @@ import-resources:
 
 # Godot binary wrapper
 @godot *ARGS: makedirs install-godot install-templates
-    {{ godot_bin }} {{ ARGS }}
+    #!/usr/bin/env sh
+    if [ "{{ env("CI", "false") }}" = "true" ]; then
+        just ci-godot-x11 {{ ARGS }}
+    else
+        {{ godot_bin }} {{ ARGS }}
+    fi
 
 # Open the Godot editor
 editor:
@@ -196,6 +201,24 @@ ci-load-dotenv:
     echo "game_name={{ game_name }}" >> $GITHUB_ENV
     echo "game_version={{ game_version }}" >> $GITHUB_ENV
 
+# Starts godot using Xvfb and pulseaudio
+ci-godot-x11 *ARGS:
+    #!/bin/bash
+    set -e
+    # Set locale to 'en' if locale is not already set.
+    # Godot will fallback to this locale anyway and it
+    # prevents an error message being printed to console.
+    [ "$LANG" == "C.UTF-8" ] && LANG=en || true
+
+    # Start dummy sound device.
+    pulseaudio --check || pulseaudio -D
+
+    # Running godot with X11 Display.
+    xvfb-run --auto-servernum {{ godot_bin }} {{ ARGS }}
+
+    # Cleanup (allowed to fail).
+    pulseaudio -k || true
+
 # Download Butler
 [private]
 install-butler: makedirs