Merge pull request #7 from Unity-Technologies/ghactions

Fix building on non-windows, package with npm, reenable tests, add GitHub Actions support

Author: shana

.appveyor.yml

@@ -6,15 +6,11 @@ environment:
    # Don't report back to the mothership
   DOTNET_CLI_TELEMETRY_OPTOUT: 1
 
-install:
-- ps: scripts\Get-Deps.ps1
-
 before_build:
-- dotnet --info
 - appveyor-retry dotnet restore -v Minimal
 
 build_script:
-- dotnet build --no-restore -c %CONFIGURATION%
+- .\build -c %CONFIGURATION%
 
 test:
   assemblies:
@@ -25,13 +21,10 @@ test:
     - DoNotRunOnAppVeyor
 
 after_test:
-- : |
-    dotnet pack --no-restore -c %CONFIGURATION%
-    set OUTDIR=build\npm
-    set SRCDIR=build\packages
-    mkdir %OUTDIR% >nul 2>nul || ver>nul
-    for /f "delims=" %%d in ('dir /b /a:d %SRCDIR%') do (pushd %SRCDIR%\%%d && for /f "delims=" %%f in ('call npm pack --quiet') do move %%f ..\..\npm\%%f && popd)
+- .\pack -c %CONFIGURATION%
 
 artifacts:
-- path: build\npm\*.tgz
-  name: Npm
+- path: upm-ci~\packages\*
+  name: npm
+- path: build\nuget\**\*.nupkg
+  name: nuget

.editorconfig

@@ -10,7 +10,7 @@ trim_trailing_whitespace=true
 indent_style=tab
 indent_size=tab
 
-[*.{config,csproj,json,nuspec,props,resxtargets,targets,sh}]
+[*.{config,csproj,json,nuspec,props,resxtargets,targets,sh,cmd}]
 indent_style=space
 indent_size=2
 tab_width=2

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: Build, Test, Pack
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 2.2.301
+    - name: Setup Node.js
+      uses: actions/setup-node@v1.1.0
+    - name: Build
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./build.sh -r
+    - name: Test
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./test.sh -r
+    - name: Pack
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./pack.sh -r

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Build, Test, Pack, Publish
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 2.2.301
+    - name: Setup Node.js
+      uses: actions/setup-node@v1.1.0
+    - name: Build
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./build.sh -r
+    - name: Test
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./test.sh -r
+    - name: Pack
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      run: ./pack.sh -r
+    - name: Publish
+      env:
+        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+        DOTNET_CLI_TELEMETRY_OPTOUT: 1
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: ./publish.sh -r -g

README.md

@@ -1,12 +1,96 @@
+![](https://github.com/unity-technologies/com.unity.editor.tasks/workflows/Build,%20Test,%20Pack/badge.svg)
+
 # About the Tasks package
 
-Unity.Editor.Tasks is a TPL-based (Task Parallel Library, or System.Threading.Tasks) task management library.
+Unity.Editor.Tasks is a TPL-based task management library.
 
-This repository is a subset of the functionality in [Git for Unity](https://github.com/Unity-Technologies/Git-for-Unity) repository, specifically the `Threading`, `OutputProcessors`, `Tasks`, `Process` and `IO` directories, as well as various helper classes found in [](https://github.com/Unity-Technologies/Git-for-Unity/tree/master/src/com.unity.git.api/Api).
+This repository is a subset of the functionality in the [Git for Unity](https://github.com/Unity-Technologies/Git-for-Unity) repository, specifically the `Threading`, `OutputProcessors`, `Tasks`, `Process` and `IO` directories, as well as various helper classes found in the [Api](https://github.com/Unity-Technologies/Git-for-Unity/tree/master/src/com.unity.git.api/Api) source directory.
 
 It's been split up for easier testing and consumption by the Git package and any other packages, libraries or apps that wish to use it.
 
+ It is essentially a wrapper of `System.Threading.Tasks.Task` objects, with custom schedulers providing easy execution of tasks in a variety of scenarios:
+
+ - UI: tasks can be scheduled to the UI thread, which uses `EditorApplication.delayCall`
+
+ - Exclusive/Concurrent: A pair of synchronized schedulers allow for a one writer/many readers scenario, where any task with an Exclusive affinity is guaranteed to run on its own without any other Exclusive or Concurrent affinity tasks executing at the same time. Concurrent affinity tasks can run with other tasks any affinity except Exclusive.
+ 	
+ 	This allows tasks to safely execute code that requires locking resources without worrying about other threads touching the same resources.
+
+- None: tasks run on the default scheduler (threadpool) without constraints.
+- LongRunning: tasks run on the default scheduler (threadpool), but the task management system doesn't expect them to finish in a short time and doesn't impose task timeouts (if the task supports such a thing);
+
+It provides easy chaining of tasks with a rx.net-like API that allows data flow from one task to the other, progress reporting, catch and finally handlers, support for wrapping async/await methods and for ensuring they run outside of play mode, and ready-made tasks for running processes and processing/streaming their output.
+
+Standard .NET async methods can be integrated into this library and executed with specific affinities using the `TPLTask` class. Similarly, going from an Editor Task to the async/await model is just a matter of awaiting the underlying `Task` property.
+
+
+## Usage examples
+
+There are a number of tests in `src/com.unity.editor.tasks/Tests/Editor` that can provide useful guidance.
+
+### Downloading a bunch of things in the background
+
+```
+// you'll want to keep one instance of this around.
+// Initialization must happen on the UI thread so it knows how to schedule things to it
+var taskManager = new TaskManager.Initialize();
+
+// the Downloader is a TaskQueue-type task which handles firing up a series of concurrent tasks,
+// aggregating all of the data from each of the tasks and returning it all together
+var downloader = new Downloader(taskManager);
+downloader.QueueDownload("http://something", "directory/to/store/file", retryCount: 2);
+
+downloader.Progress(progress => { ShowProgress(progress.Message, progress.InnerProgress?.Message, progress.Percentage); });
+
+downloader.OnStart += __ => logger.Info("Downloading assets...");
+downloader.OnEnd += (___, __, success, ex) => logger.Info($"Downloader is done with result: {success}");
+
+downloader.FinallyInUI((success, exception, results) => {
+	// do something with all the things that were downloaded
+});
 
+downloader.Start();
+
+```
+
+
+ ### Chaining tasks
+
+```
+void ShowProgress(string title, string message, float pct) => TaskManager.RunInUI(() => EditorUtility.DisplayProgressBar(title, message, pct), "Updating progress");
+
+// you'll want to keep one instance of this around.
+// Initialization must happen on the UI thread so it knows how to schedule things to it
+var taskManager = new TaskManager.Initialize();
+
+EditorUtility.DisplayProgressBar("Starting", "", 0);
+var chainOfTasks = new FuncTask(taskManager, () => "Do something critical and return a string.", affinity: TaskAffinity.Exclusive)
+
+	// each task has its own progress event/handler.
+	.Progress(progress => ShowProgress(progress.Message, progress.InnerProgress?.Message, progress.Percentage))
+
+	// do something with the value the previous task produced, with Concurrent affinity.
+	// This won't run if the previous one failed
+	.Then(str => str.ToUpper())
+
+	.Progress(progress => ShowProgress(progress.Message, progress.InnerProgress?.Message, progress.Percentage))
+
+	// finally handlers will always be called. Always end a chain with a Finally* handler!
+	.FinallyInUI((success, exception, value) => {
+		EditorUtility.ClearProgressBar();
+
+		if (success) {
+			// do something on success
+			EditorUtility.DisplayDialog("All done", value);
+		} else {
+			Debug.LogException(exception);
+		}
+	});
+
+// start executing the whole thing
+chainOfTasks.Start();
+
+```
 
 ## The History
 
@@ -21,5 +105,7 @@ These days, Unity supports modern .NET and can compile all this code just fine,
 **[MIT](LICENSE)**
 
 Copyright (c) 2019 Unity Technologies
+
 Copyright (c) 2016-2019 Andreia Gaita
+
 Copyright (c) 2016-2018 GitHub

build.cmd

@@ -9,42 +9,51 @@ SET CONFIGURATION=Release
 SET PUBLIC=""
 SET BUILD=0
 set UPM=0
+set UNITYVERSION=2019.2
 
 :loop
 IF NOT "%1"=="" (
-    IF "%1"=="-p" (
-        SET PUBLIC=/p:PublicRelease=true
-    )
-    IF "%1"=="--public" (
-        SET PUBLIC=/p:PublicRelease=true
-    )
-    IF "%1"=="-b" (
-        SET BUILD=1
-    )
-    IF "%1"=="--build" (
-        SET BUILD=1
-    )
-    IF "%1"=="-d" (
-        SET CONFIGURATION=Debug
-    )
-    IF "%1"=="--debug" (
-        SET CONFIGURATION=Debug
-    )
-    IF "%1"=="-r" (
-        SET CONFIGURATION=Release
-    )
-    IF "%1"=="--release" (
-        SET CONFIGURATION=Release
-    )
-    IF "%1"=="-u" (
-        SET UPM=1
-    )
-    IF "%1"=="--upm" (
-        SET UPM=1
-    )
+  IF "%1"=="-p" (
+    SET PUBLIC=-p:PublicRelease=true
+  )
+  IF "%1"=="--public" (
+    SET PUBLIC=-p:PublicRelease=true
+  )
+  IF "%1"=="-b" (
+    SET BUILD=1
+  )
+  IF "%1"=="--build" (
+    SET BUILD=1
+  )
+  IF "%1"=="-d" (
+    SET CONFIGURATION=Debug
+  )
+  IF "%1"=="--debug" (
+    SET CONFIGURATION=Debug
+  )
+  IF "%1"=="-r" (
+    SET CONFIGURATION=Release
+  )
+  IF "%1"=="--release" (
+    SET CONFIGURATION=Release
+  )
+  IF "%1"=="-u" (
+    SET UPM=1
+  )
+  IF "%1"=="--upm" (
+    SET UPM=1
+  )
+  IF "%1"=="-c" (
+    SET CONFIGURATION=%2
     SHIFT
-    GOTO :loop
+  )
+  SHIFT
+  GOTO :loop
+)
+
+if "%APPVEYOR%" == "" (
+  dotnet restore
 )
 
-dotnet restore
 dotnet build --no-restore -c %CONFIGURATION% %PUBLIC%
+

build.sh

@@ -1,6 +1,6 @@
-#!/bin/sh -eu
+#!/bin/bash -eu
 { set +x; } 2>/dev/null
-SOURCE="${BASH_SOURCE[0]}"
+SOURCE=$0
 DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
 
 OS="Mac"
@@ -12,45 +12,50 @@ CONFIGURATION=Release
 PUBLIC=""
 BUILD=0
 UPM=0
+UNITYVERSION=2019.2
+YAMATO=0
 
 while (( "$#" )); do
   case "$1" in
     -d|--debug)
       CONFIGURATION="Debug"
-      shift
     ;;
     -r|--release)
       CONFIGURATION="Release"
-      shift
     ;;
     -p|--public)
-      PUBLIC="/p:PublicRelease=true"
-      shift
+      PUBLIC="-p:PublicRelease=true"
     ;;
     -b|--build)
       BUILD=1
-      shift
     ;;
     -u|--upm)
       UPM=1
+    ;;
+    -c)
       shift
+      CONFIGURATION=$1
     ;;
     -*|--*=) # unsupported flags
       echo "Error: Unsupported flag $1" >&2
       exit 1
-      ;;
-    *)
-      shift
     ;;
   esac
+  shift
 done
 
-if [[ x"$OS" == x"Windows" && x"$PUBLIC" != x"" ]]; then
-  PUBLIC="/$PUBLIC"
+if [[ x"${YAMATO_JOB_ID:-}" != x"" ]]; then
+  YAMATO=1
+  export GITLAB_CI=1
+  export CI_COMMIT_TAG="${GIT_TAG:-}"
+  export CI_COMMIT_REF_NAME="${GIT_BRANCH:-}"
 fi
 
 pushd $DIR >/dev/null 2>&1
-dotnet build-server shutdown >/dev/null 2>&1 || true
-dotnet restore
+
+if [[ x"${APPVEYOR:-}" == x"" ]]; then
+  dotnet restore
+fi
 dotnet build --no-restore -c $CONFIGURATION $PUBLIC
+
 popd >/dev/null 2>&1

clean.sh

@@ -1,4 +1,4 @@
-#!/bin/sh -eu
+#!/bin/bash -eu
 { set +x; } 2>/dev/null
 SOURCE="${BASH_SOURCE[0]}"
 DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"