Skip to content

Commit 6db5e5e

Browse files
committed
Unity setup docs
1 parent daab784 commit 6db5e5e

11 files changed

+299
-79
lines changed
-11.3 KB
Loading
-131 Bytes
Loading

docs/02-tasks/02-unity-setup-task.md

Lines changed: 290 additions & 58 deletions
Large diffs are not rendered by default.

docs/02-tasks/03-unity-activate-license-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unity Activate License Task
44
sidebar_label: Unity Activate License Task
55
---
66

7-
## About
7+
# About the Unity Activate License Task
88

99
This task is used to activate a Untiy Plus/Pro license on the executing agent machine. You can find the task when editing your pipeline by searching for the name `Unity Activate License`.
1010

docs/02-tasks/04-unity-build-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unity Build Task
44
sidebar_label: Unity Build Task
55
---
66

7-
## About
7+
# About the Unity Build Task
88

99
This task is responsible for actually building your Unity project and as such the core task of your pipeline. In many cases it will be the only task you'll need from the collection of tasks this extension provides. Unity Build will build your project and provide the output files for further processing as needed. You can find the task when editing your pipeline by searching for the name `Unity Build`.
1010

docs/02-tasks/05-unity-cmd-task.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unity CMD Task
44
sidebar_label: Unity CMD Task
55
---
66

7-
## About
7+
# About the Unity CMD Task
88

99
This task allows for full control over the arguments passed to the Unity command line. It's aimed at advanced users with specific requirements. For most use cases and users the use of the other provided tasks is recommended as it provides a guided and targeted experience. You can find the task when editing your pipeline by searching for the name `Unity CMD`. In short: use this task only if you know what you are doing.
1010

@@ -102,18 +102,4 @@ steps:
102102

103103
- script: |
104104
echo $(unitycmd.logsOutputPath)
105-
```
106-
107-
### Classic Pipeline Editor
108-
109-
The classic (visual) editor for Azure Pipelines provides input fields for configuring the task. In the simple example below, we set `Unity editors location` to use the default Unity Hub installation path to lookup installed Unity editor versions on the agent running our pipeline. We are also leaving the `Unity project path` field empty, since we know our Unity project is in the repository root. For `Command line arguments` we specify that Unity should target the `standalone` platform and execute our custom build script `MyBuildTools.BuildProject` to perform the build. We are also assigning a `Reference name` to the task, so we can use it to refernce the output variables in the variables list in other tasks of the pipeline. E.g. to get the value of the `logsOutputPath` output variable and insert it into any other input field of a task we can then use `$(unitycmd.logsOutputPath)`.
110-
111-
![Classic Pipeline Designer Task Configuration](../../static/img/unity-cmd-task/unity-cmd-classic.png)
112-
113-
---
114-
115-
## Log
116-
117-
When run and successful the task will provide log output similar to this:
118-
119-
![Task Log](../../static/img/unity-cmd-task/unity-cmd-log.png)
105+
```

docs/02-tasks/06-unity-create-project-task.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
id: unity-create-project-task
33
title: Unity Create Project Task
44
sidebar_label: Unity Create Project Task
5-
---
5+
---
6+
7+
# About the Unity Create Project Task

docs/02-tasks/07-unity-get-project-version-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unity Get Project Version Task
44
sidebar_label: Unity Get Project Version Task
55
---
66

7-
## About
7+
# About the Unity Get Project Version Task
88

99
This task will find the Unity Editor version the project was last opened with. This is especially useful
1010
when you need to perform steps in your pipeline that depend on which Unity version is required for the project to build

docs/02-tasks/08-unity-test-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unity Test Task
44
sidebar_label: Unity Test Task
55
---
66

7-
## About
7+
# About the Unity Test Task
88

99
This task is used for running unit tests in your project. Test results will output into a test results file and the file path is provided for uploading and processing. You can find the task when editing your pipeline by searching for the name `Unity Test`.
1010

-10.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)