Fix Unity installation error on Linux (#552)

Author: sunmou99

.github/workflows/build_linux.yml

@@ -38,7 +38,7 @@ on:
 jobs:
   build_desktop:
     name: build-linux-unity${{inputs.unity_version}}-CPP${{ inputs.firebase_cpp_sdk_version }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
 

gha/unity/README.md

@@ -19,7 +19,7 @@ This GitHub Action will provide `UNITY_VERSION` (full unity version, e.g. `2020.
 
 -   Output usage:
     ```yml
-    - uses: firebase/firebase-unity-sdk/gha/unity@main
+    - uses: ./gha/unity
       with:
         version: ${{ unity_version }}
         platforms: ${{ platforms }}
@@ -37,13 +37,13 @@ This GitHub Action will provide `UNITY_VERSION` (full unity version, e.g. `2020.
 
         steps:
           # ...
-          - uses: firebase/firebase-unity-sdk/gha/unity@main
+          - uses: ./gha/unity
             with:
               version: ${{ unity_version }}
               platforms: ${{ platforms }}
     ```
 
--   Install Unity, Activate and Release Unity License
+-   Install Unity, Activate and Release Unity License. Always release the license after usage.
     ```yml
     jobs:
       build_testapp:
@@ -52,7 +52,7 @@ This GitHub Action will provide `UNITY_VERSION` (full unity version, e.g. `2020.
         steps:
           # ...
           - id: unity_setup_and_activate
-            uses: firebase/firebase-unity-sdk/gha/unity@main
+            uses: ./gha/unity
             with:
               version: ${{ unity_version }}
               platforms: ${{ platforms }}
@@ -61,7 +61,7 @@ This GitHub Action will provide `UNITY_VERSION` (full unity version, e.g. `2020.
               serial_ids: ${{ secrets.SERIAL_ID }}
           # ...
           - id: release_license
-            uses: firebase/firebase-unity-sdk/gha/unity@main
+            uses: ./gha/unity
             with:
               version: ${{ unity_version }}
               release_license: "true"
@@ -72,18 +72,21 @@ This GitHub Action will provide `UNITY_VERSION` (full unity version, e.g. `2020.
 
 This GitHub Action leverages [Unity Hub](https://unity3d.com/get-unity/download), which is a standalone application that streamlines the way you navigate, download, and manage your Unity projects and installations. Unity Hub is with beta version CLI support, and we are using it for Unity versions management.
 
-In this GitHub Action, supported Unity Versions are maintained by `SETTINGS` in `gha/unity/unity_installer.py`. 
+In this GitHub Action, supported Unity Versions are maintained by `SETTINGS` in [`gha/unity/unity_installer.py`](https://github.com/firebase/firebase-unity-sdk/blob/unity-readme/gha/unity/unity_installer.py#L89). 
 
 **Add a new Unity version support**
 
-1. Select your version from [Unity LTS versions list](https://unity3d.com/unity/qa/lts-releases) and make sure this version can be installed with Unity Hub.
+1. Select your version from [Unity LTS versions list](https://unity3d.com/unity/qa/lts-releases):
+  -   Make sure this version can be installed with Unity Hub. 
+  -   Make sure this version works on you computer first.
+  -   You may need to select different versions for different OS.
 
-2. Generate new JSON string and added it to `UNITY_SETTINGS`:
+2. Generate a JSON string which contains the following information and added it to `UNITY_SETTINGS`:
   -   `Major_version_number`: unity major version number: `2020`, `2021`, etc.
   -   `Full_version_number`: unity full version number. e.g. `2020.3.34f1` for major version `2020`.
   -   `Changeset`: changeset locates at the bottom of this page https://unity3d.com/unity/whats-new/{unity_version}. Note: the version is neither `Major_version_number` nor `Full_version_number`. e.g. https://unity3d.com/unity/whats-new/2020.3.34
   -   `Platform`: Firebase Unity SDK supported platforms. Values of [Android,iOS,tvOS,Windows,macOS,Linux]
-  -   `Modules`:[Unity Hub must been installed] Unity modules that required for certain platform. e.g. ["windows-mono"] module for "Windows" platform. To list avaliable modules, run `"/Applications/Unity Hub.app/Contents/MacOS/Unity Hub" -- --headless help` on your mac machine.
+  -   `Modules`:[Unity Hub must been installed] Unity modules that required for certain platform. e.g. ["windows-mono"] module for "Windows" platform. To list avaliable modules on mac machines, run `"/Applications/Unity Hub.app/Contents/MacOS/Unity Hub" -- --headless help` .
 
       Template:
       ```

gha/unity/unity_installer.py

@@ -91,18 +91,18 @@
   "unity_hub_url": {
     WINDOWS: "https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.exe",
     MACOS: "https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.dmg",
-    LINUX: "https://public-cdn.cloud.unity3d.com/hub/prod/UnityHub.AppImage",
+    LINUX: "",
   },
   # Unity Hub will be installed at this location
   "unity_hub_path": {
     WINDOWS: '"C:/Program Files/Unity Hub/Unity Hub.exe"',
     MACOS: '"/Applications/Unity Hub.app"',
-    LINUX: '"/home/runner/Unity Hub/UnityHub.AppImage"',
+    LINUX: '/usr/bin/unityhub',
   },
   "unity_hub_executable": {
     WINDOWS: '"C:/Program Files/Unity Hub/Unity Hub.exe" -- --headless',
     MACOS: '"/Applications/Unity Hub.app/Contents/MacOS/Unity Hub" -- --headless',
-    LINUX: 'xvfb-run --auto-servernum "/home/runner/Unity Hub/UnityHub.AppImage" --headless',
+    LINUX: 'xvfb-run unityhub --headless',
   },
   # Unity will be installed at this location
   "unity_path": {
@@ -241,8 +241,9 @@ def install(unity_version, platforms):
 def install_unity_hub():
   runner_os = get_os()
   unity_hub_url = SETTINGS["unity_hub_url"][runner_os]
-  unity_hub_installer = path.basename(unity_hub_url)
-  download_unity_hub(unity_hub_url, unity_hub_installer, max_attempts=MAX_ATTEMPTS)
+  if unity_hub_url:
+    unity_hub_installer = path.basename(unity_hub_url)
+    download_unity_hub(unity_hub_url, unity_hub_installer, max_attempts=MAX_ATTEMPTS)
   if runner_os == MACOS:
     run(f'sudo hdiutil attach {unity_hub_installer}', max_attempts=MAX_ATTEMPTS)
     mounted_to = glob.glob("/Volumes/Unity Hub*/Unity Hub.app")
@@ -253,13 +254,11 @@ def install_unity_hub():
   elif runner_os == WINDOWS:
     run(f'{unity_hub_installer} /S', max_attempts=MAX_ATTEMPTS)
   elif runner_os == LINUX:
-    home_dir = os.environ["HOME"]
-    unity_hub_path = SETTINGS["unity_hub_path"][runner_os]
-    run(f'mkdir -p "{home_dir}/Unity Hub" "{home_dir}/.config/Unity Hub"')
-    run(f'mv {unity_hub_installer} {unity_hub_path}')
-    run(f'chmod +x {unity_hub_path}')
-    run(f'touch "{home_dir}/.config/Unity Hub/eulaAccepted"', max_attempts=MAX_ATTEMPTS)
-
+    # https://docs.unity3d.com/hub/manual/InstallHub.html#install-hub-linux
+    run('sudo sh -c \'echo "deb https://hub.unity3d.com/linux/repos/deb stable main" > /etc/apt/sources.list.d/unityhub.list\'')
+    run('wget -qO - https://hub.unity3d.com/linux/keys/public | sudo apt-key add -', max_attempts=MAX_ATTEMPTS)
+    run('sudo apt update')
+    run('sudo apt-get install unityhub', max_attempts=MAX_ATTEMPTS)
 
 def download_unity_hub(unity_hub_url, unity_hub_installer, max_attempts=1):
   attempt_num = 1