Add config flag that drops -quit from builder

[dginovker]

Context

My team has a situation where we can’t run playtests because of asmdef’s in Unity not working with our project flow, but instead found a way to validate things in-game by running a scene from the command line (scene is started from a static method). We want to start the scene to run the tests before a build, but you can't enter playmode from a static method in -batchmode if -quit is also present.

A configuration option that allows removing -quit from the Unity command line parameters would solve our issue (although it means we need to handle the exiting of the editor ourselves with EditorApplication.Exit(0))

Suggested solution

Add a config like

quit

Bool whether the editor should quit after building
Note: If quit is disabled, your build method must handle exiting Unity with EditorApplication.Exit(0) on its own
required: false default: true

Considered alternatives

Forking the builder and monkey patching it

Additional details

We can't call /opt/unity/Editor/Unity ourselves since it's gone when you leave the build step. It would also mean we have to redo the licensing/etc

The following is some bash code that can handle the optionally passing -quit, although I don't have an equivalent for the Powershell build.ps1

#!/usr/bin/env bash

function printparams() {
  echo "$@"
  echo "$#"
}

quit=""

printparams \
  ${quit} \
  -two

quit="-quit"

printparams \
  ${quit} \
  -two

[webbertakken]

Yup sounds good!

Thank you for your nice suggestion and the details.
We should probably add a parameter called manualExit to our public api, which would be set to false by default.

Accepting PRs for this.

[webbertakken]

Added this to the Roadmap to v3.0.0.

It should probably be configurable through a plugin.

[webbertakken]

More use-case details in linked issue ^

[JohannesDeml]

For anyone else running into the limitation: As a quickfix you could just fork the repo and remove the -quit parameter for now. Example: https://github.com/JohannesDeml/unity-builder/commits/no-quit-parameter
Usage: https://github.com/JohannesDeml/UnityWebGL-LoadingTest/blob/master/.github/workflows/upgrade-unity.yml#L95

      - name: Build project
        uses: JohannesDeml/unity-builder@no-quit-parameter
        env:
          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
        with:
          buildMethod: UnityBuilderAction.UnityPackageScripts.UpgradeAllPackagesToVerifiedVersion
          customParameters: ${{ inputs.customParameters }}
          unityVersion: ${{ inputs.unityVersion }}
          targetPlatform: WebGL
          buildName: ${{ needs.variables.outputs.BUILD_NAME }}
          allowDirtyBuild: true

[tobyspark]

I didn’t see any way to suppress -quit in the current v3 code, so made a PR. I called the option manualExit as suggested in this thread.