Split build target from build environment (#1012)

Author: Paul Balaji

.buildkite/premerge.steps.yaml

@@ -49,16 +49,29 @@ steps:
     artifact_paths:
       - logs/**/*
 
-  - label: "build :android: and iOS"
+  - label: "build :android:"
     command: bash -c .shared-ci/scripts/build-worker.sh
     <<: *common
     artifact_paths:
       - logs/**/*
       - workers/unity/build/worker/**/*
     env:
       WORKER_TYPE: "MobileClient"
-      BUILD_TARGET: "local"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "local"
+      BUILD_TARGET_FILTER: "android"
+      SCRIPTING_BACKEND: "mono"
+
+  - label: "build iOS"
+    command: bash -c .shared-ci/scripts/build-worker.sh
+    <<: *common
+    artifact_paths:
+      - logs/**/*
+      - workers/unity/build/worker/**/*
+    env:
+      WORKER_TYPE: "MobileClient"
+      BUILD_ENVIRONMENT: "local"
+      BUILD_TARGET_FILTER: "ios"
+      SCRIPTING_BACKEND: "il2cpp"
 
   - label: "build UnityClient mono"
     command: bash -c .shared-ci/scripts/build-worker.sh
@@ -67,8 +80,8 @@ steps:
       - logs/**/*
     env:
       WORKER_TYPE: "UnityClient"
-      BUILD_TARGET: "cloud"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "cloud"
+      SCRIPTING_BACKEND: "mono"
 
   - label: "build UnityClient il2cpp"
     command: bash -c .shared-ci/scripts/build-worker.sh
@@ -77,8 +90,8 @@ steps:
       - logs/**/*
     env:
       WORKER_TYPE: "UnityClient"
-      BUILD_TARGET: "local"
-      SCRIPTING_TYPE: "il2cpp"
+      BUILD_ENVIRONMENT: "local"
+      SCRIPTING_BACKEND: "il2cpp"
 
   - label: "build UnityGameLogic mono"
     command: bash -c .shared-ci/scripts/build-worker.sh
@@ -87,5 +100,5 @@ steps:
       - logs/**/*
     env:
       WORKER_TYPE: "UnityGameLogic"
-      BUILD_TARGET: "cloud"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "cloud"
+      SCRIPTING_BACKEND: "mono"

.buildkite/release-qa.steps.yaml

@@ -35,16 +35,29 @@ common: &common
 # These are then relied on to have stable names by other things, so once named, please beware renaming has consequences.
 
 steps:
-  - label: "build :android: and iOS"
+  - label: "build :android:"
     command: bash -c .shared-ci/scripts/build-worker.sh
     <<: *common
     artifact_paths:
       - logs/**/*
       - build/assembly/**/*
     env:
       WORKER_TYPE: "MobileClient"
-      BUILD_TARGET: "local"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "cloud"
+      BUILD_TARGET_FILTER: "android"
+      SCRIPTING_BACKEND: "mono"
+
+  - label: "build iOS"
+    command: bash -c .shared-ci/scripts/build-worker.sh
+    <<: *common
+    artifact_paths:
+      - logs/**/*
+      - build/assembly/**/*
+    env:
+      WORKER_TYPE: "MobileClient"
+      BUILD_ENVIRONMENT: "cloud"
+      BUILD_TARGET_FILTER: "ios"
+      SCRIPTING_BACKEND: "il2cpp"
 
   - label: "build UnityClient mono"
     command: bash -c .shared-ci/scripts/build-worker.sh
@@ -54,8 +67,8 @@ steps:
       - build/assembly/**/*
     env:
       WORKER_TYPE: "UnityClient"
-      BUILD_TARGET: "cloud"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "cloud"
+      SCRIPTING_BACKEND: "mono"
 
   - label: "build UnityGameLogic mono"
     command: bash -c .shared-ci/scripts/build-worker.sh
@@ -65,8 +78,8 @@ steps:
       - build/assembly/**/*
     env:
       WORKER_TYPE: "UnityGameLogic"
-      BUILD_TARGET: "cloud"
-      SCRIPTING_TYPE: "mono"
+      BUILD_ENVIRONMENT: "cloud"
+      SCRIPTING_BACKEND: "mono"
   - wait
   - label: Launch deployments
     command: bash -c ci/launch.sh

CHANGELOG.md

@@ -2,10 +2,16 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+- Renamed the `buildTarget` command line argument to `buildEnvironment`. [#1012](https://github.com/spatialos/gdk-for-unity/pull/1012)
+
 ### Added
 
 - Added the `LinkedGameObjectMap` class for finding the `GameObject`(s) linked with a specified `EntityId`. [#1013](https://github.com/spatialos/gdk-for-unity/pull/1013)
     - This can be used with the `[Require]` annotation to inject it into your `MonoBehaviours` provided you are using the `GameObjectCreation` feature module. For example: `[Require] private LinkedGameObjectMap gameObjectMap;`
+- Added the ability for the build system to build specific targets of a given build environment. [#1012](https://github.com/spatialos/gdk-for-unity/pull/1012)
+    - Use the `buildTargetFilter` command line argument to pass in a comma delimited list of build targets to filter for. For example, `+buildTargetFilter win,macos`.
 
 ### Internal
 
@@ -39,7 +45,7 @@
         - `List<LoginTokenDetails> GetDevelopmentLoginTokens(string workerType, string playerIdentityToken)`
     - The `WorkerConnector` has also had the following changes:
         - The `public Worker Worker;` field is now the `public WorkerInWorld Worker;` field.
-        - The `public async Task Connect(string workerType, ILogDispatcher logger)` method is now `protected async Task Connect(IConnectionHandlerBuilder builder, ILogDispatcher logger)`. 
+        - The `public async Task Connect(string workerType, ILogDispatcher logger)` method is now `protected async Task Connect(IConnectionHandlerBuilder builder, ILogDispatcher logger)`.
     - The `Worker` class has had the following changes:
         - The `public Connection Connection { get; private set; }` property has been removed.
         - The `public World World { get; private set; }` property has been moved to the `WorkerInWorld` class.

UPGRADE_GUIDE.md

@@ -1,5 +1,29 @@
 # Upgrade Guide
 
+## From `0.2.4` to `0.2.5`
+
+### Build system changes
+
+When calling the build system from the command line, you must change the `buildTarget` argument to `buildEnvironment`. Previously you may have called the build system like so:
+
+```bash
+Unity.exe <arguments> \
+    -executeMethod "Improbable.Gdk.BuildSystem.WorkerBuilder.Build" \
+    +buildWorkerTypes "UnityGameLogic" \
+    +buildTarget "cloud" \
+    +scriptingBackend "mono"
+```
+
+You must change this to:
+
+```bash
+Unity.exe <arguments> \
+    -executeMethod "Improbable.Gdk.BuildSystem.WorkerBuilder.Build" \
+    +buildWorkerTypes "UnityGameLogic" \
+    +buildEnvironment "cloud" \
+    +scriptingBackend "mono"
+```
+
 ## From `0.2.3` to `0.2.4`
 
 ### General changes
@@ -129,15 +153,15 @@ Previously, there were a set of virtual methods on the `WorkerConnector` class t
 | Method | Class |
 | --- | --- |
 | `SelectDeploymentName(DeploymentList deployments)` | `LocatorFlow` |
-| `GetPlayerId()` | `AlphaLocatorFlow` | 
-| `GetDisplayName()` | `AlphaLocatorFlow` | 
+| `GetPlayerId()` | `AlphaLocatorFlow` |
+| `GetDisplayName()` | `AlphaLocatorFlow` |
 | `string SelectLoginToken(List<LoginTokenDetails> loginTokens)` | `AlphaLocatorFlow` |
 | `string GetDevelopmentPlayerIdentityToken(string authToken, string playerId, string displayName)` | `AlphaLocatorFlow` |
 | `List<LoginTokenDetails> GetDevelopmentLoginTokens(string workerType, string playerIdentityToken)` | `AlphaLocatorFlow` |
 
 #### Mobile setup
 
-The mobile setup is a little bit special. There are built-in initializers for the connection flows and connection parameters in the mobile package. These replicate the behaviour of the `DefaultMobileWorkerConnector`. 
+The mobile setup is a little bit special. There are built-in initializers for the connection flows and connection parameters in the mobile package. These replicate the behaviour of the `DefaultMobileWorkerConnector`.
 
 The `MobileConnectionFlowInitializer` constructor takes any number of `IMobileSettingsProvider` objects and will use these to get mobile specific settings (such as the host IP address for the receptionist). The order in which you provide these objects _does matter_ as the first one to return a valid setting for each setting will be used. We provide two implementations of this interface in the mobile package, one for command line arguments and one for player prefs.
 

ci/build-test.sh

@@ -6,8 +6,6 @@ cd "$(dirname "$0")/../"
 ci/bootstrap.sh
 
 source .shared-ci/scripts/pinned-tools.sh
-source .shared-ci/scripts/profiling.sh
 
-markStartOfBlock "Running Docs Linter"
-dotnet run -p .shared-ci/tools/DocsLinter/DocsLinter.csproj 
-markEndOfBlock "Running Docs Linter"
+echo "Running Docs Linter"
+dotnet run -p .shared-ci/tools/DocsLinter/DocsLinter.csproj

ci/docs-lint.sh

@@ -4,7 +4,6 @@ set -e -u -x -o pipefail
 
 cd "$(dirname "$0")/../"
 
-source ".shared-ci/scripts/profiling.sh"
 source ".shared-ci/scripts/pinned-tools.sh"
 
 if [[ -n "${BUILDKITE-}" ]]; then
@@ -17,7 +16,7 @@ fi
 
 uploadAssembly "${ASSEMBLY_PREFIX}" "${PROJECT_NAME}"
 
-markStartOfBlock "Launching deployment"
+echo "Launching deployment"
 
 spatial cloud launch "${ASSEMBLY_NAME}" cloud_launch.json "${ASSEMBLY_NAME}" --snapshot=snapshots/default.snapshot | tee -a ./launch.log
 
@@ -31,5 +30,3 @@ if [[ -n "${BUILDKITE-}" ]]; then
         buildkite-agent annotate --style "warning" "Could not parse deployment URL from launch log."
     fi
 fi
-
-markEndOfBlock "Launching deployment"

ci/launch.sh

@@ -1 +1 @@
-02385564bd29e3cc566951f7e38a1e9530846b7e
+e056fe31826b64dbdf51b6974ba36d9908e32f9e

ci/shared-ci.pinned

@@ -6,18 +6,17 @@ cd "$(dirname "$0")/../"
 ci/bootstrap.sh
 
 source .shared-ci/scripts/pinned-tools.sh
-source .shared-ci/scripts/profiling.sh
 
 if isDocsBranch; then
     exit 0
 fi
 
-markStartOfBlock "$0"
+echo "$0"
 
 #####
 # Setup variables
 #####
-markStartOfBlock "Setup variables"
+echo "Setup variables"
 PROJECT_DIR="$(pwd)"
 mkdir -p "${PROJECT_DIR}/logs/"
 
@@ -31,22 +30,18 @@ rm  "${CODE_GENERATOR_TEST_RESULTS_FILE}" \
     "${EDITMODE_TEST_RESULTS_FILE}" \
     "${PLAYMODE_TEST_RESULTS_FILE}"
 
-markEndOfBlock "Setup variables"
-
 cleanUnity "$(pwd)/workers/unity"
 cleanUnity "$(pwd)/test-project"
 
-markStartOfBlock "Code Generator Testing"
+echo "Code Generator Testing"
 
 dotnet test --logger:"nunit;LogFilePath=${CODE_GEN_LIB_TEST_RESULTS_FILE}" workers/unity/Packages/com.improbable.gdk.tools/.CodeGenerator/CodeGeneration/CodeGeneration.csproj
 CODE_GEN_LIB_TEST_RESULT=$?
 
 dotnet test --logger:"nunit;LogFilePath=${CODE_GENERATOR_TEST_RESULTS_FILE}" workers/unity/Packages/com.improbable.gdk.tools/.CodeGenerator/GdkCodeGenerator/GdkCodeGenerator.csproj
 CODE_GENERATOR_TEST_RESULT=$?
 
-markEndOfBlock "Code Generator Testing"
-
-markStartOfBlock "Editmode Testing"
+echo "Editmode Testing"
 
 pushd "workers/unity"
     dotnet run -p "${PROJECT_DIR}/.shared-ci/tools/RunUnity/RunUnity.csproj" -- \
@@ -60,11 +55,9 @@ pushd "workers/unity"
     EDITMODE_TEST_RESULT=$?
 popd
 
-markEndOfBlock "Editmode Testing"
-
 cleanUnity "$(pwd)/workers/unity"
 
-markStartOfBlock "Playmode Testing"
+echo "Playmode Testing"
 
 pushd "workers/unity"
     dotnet run -p "${PROJECT_DIR}/.shared-ci/tools/RunUnity/RunUnity.csproj" -- \
@@ -78,10 +71,9 @@ pushd "workers/unity"
     PLAYMODE_TEST_RESULT=$?
 popd
 
-markEndOfBlock "Playmode Testing"
+echo "Generated Code Testing"
 
 pushd "test-project"
-markStartOfBlock "Generated Code Testing"
     dotnet run -p "${PROJECT_DIR}/.shared-ci/tools/RunUnity/RunUnity.csproj" -- \
         -batchmode \
         -projectPath "${PROJECT_DIR}/test-project" \
@@ -93,8 +85,6 @@ markStartOfBlock "Generated Code Testing"
     TEST_PROJECT_EDITMODE_TEST_RESULT=$?
 popd
 
-markEndOfBlock "Generated Code Testing"
-
 if [ $CODE_GEN_LIB_TEST_RESULT -ne 0 ]; then
     >&2 echo "Code Generator Tests failed. Please check the file ${CODE_GEN_LIB_TEST_RESULTS_FILE} for more information."
 fi
@@ -115,8 +105,6 @@ if [ $TEST_PROJECT_EDITMODE_TEST_RESULT -ne 0 ]; then
     >&2 echo "Test Project Editmode Tests failed. Please check the file ${TEST_PROJECT_EDITMODE_TEST_RESULTS_FILE} for more information."
 fi
 
-markEndOfBlock "$0"
-
 cleanUnity "$(pwd)/workers/unity"
 cleanUnity "$(pwd)/test-project"