Skip to content

Commit 03d6c93

Browse files
FejZaFejZa
committed
Create project task docs
1 parent 267d1da commit 03d6c93

File tree

3 files changed

+81
-5
lines changed

3 files changed

+81
-5
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Another purpose of this task is to activate a license / seat on the agent, shoul
2222
2323
## Inputs
2424
25-
### unityEditorsPathMode
25+
### unityHubExecutableLocation
2626
2727
For the task to run successfully it needs to know where the Unity Hub executable can be found on the agent. This input defines where to look for it.
2828

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ Enter the directory path to the Unity project. If no value is entered, the proje
9898

9999
### unityEditorsLocation
100100

101-
For the task to run successfully it needs to know where the Unity Hub executable can be found on the agent. This input defines where to look for it.
101+
For the task to run successfully it needs to know where Unity installations are located at on the agent. This input lets you configure,
102+
where the task should look for installations.
102103

103104
| YAML | Classic Editor | Required | Default |
104105
|----------------------------|-------------------------------|----------|---------|
@@ -108,8 +109,9 @@ For the task to run successfully it needs to know where the Unity Hub executable
108109

109110
| Value | Description |
110111
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
111-
| default | Uses the Unity Hub default installation path for editor installations |
112-
| specify | Let's you specify a custom path where to look for the Unity Hub executable. See also input `unityEditorsLocation` |
112+
| default | Uses the Unity Hub default installation path |
113+
| environmentVariable | Expects an environment variable `UNITYHUB_EDITORS_FOLDER_LOCATION` to exist on the agent and specifying where to find editor installations. |
114+
| specify | Let's you specify a custom path where to lookup editor installations using the input `customUnityEditorsLocation` |
113115

114116
### customUnityEditorsLocation
115117

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

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,78 @@ title: Unity Create Project Task
44
sidebar_label: Unity Create Project Task
55
---
66

7-
# About the Unity Create Project Task
7+
# About the Unity Create Project Task
8+
9+
This task is used to create a new and empty project. This is e.g. useful for package development, where you want
10+
to have the pipeline validate a Unity package in multiple Unity versions in an empty project to make sure it builds as expected.
11+
12+
## Syntax
13+
14+
```yaml
15+
# Unity Create Project V1
16+
# Create a new project using Unity 6000.0.30f1 at the path /New Project/My Project/
17+
- task: UnityCreateProjectTask@1
18+
inputs:
19+
version: '6000.0.30f1'
20+
path: 'New Project'
21+
projectName: 'My Project'
22+
```
23+
24+
## Inputs
25+
26+
### version
27+
28+
The version of the Unity editor to work with and create the project with, e.g. `6000.0.30f1`.
29+
30+
| YAML | Classic Editor | Required | Default |
31+
|----------------------------|-------------------------------|----------|---------|
32+
| `version` | Version | Yes | - |
33+
34+
### path
35+
36+
Enter the path to create the Unity project at. If no value is entered, the root pipeline workspace is used.
37+
38+
| YAML | Classic Editor | Required | Default |
39+
|----------------------------|-------------------------------|----------|---------|
40+
| `path` | Path | No | - |
41+
42+
### projectName
43+
44+
The name of the Unity project created. The project name is also the name of the folder created for the project.
45+
46+
| YAML | Classic Editor | Required | Default |
47+
|----------------------------|-------------------------------|----------|---------|
48+
| `projectName` | Project Name | Yes | New Project |
49+
50+
### unityEditorsPathMode
51+
52+
For the task to run successfully it needs to know where Unity installations are located at on the agent. This input lets you configure,
53+
where the task should look for installations.
54+
55+
| YAML | Classic Editor | Required | Default |
56+
|----------------------------|-------------------------------|----------|---------|
57+
| `unityEditorsPathMode` | Unity editors location | Yes | default |
58+
59+
#### Options:
60+
61+
| Value | Description |
62+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
63+
| default | Uses the Unity Hub default installation path |
64+
| environmentVariable | Expects an environment variable `UNITYHUB_EDITORS_FOLDER_LOCATION` to exist on the agent and specifying where to find editor installations. |
65+
| specify | Let's you specify a custom path where to lookup editor installations using the input `customUnityEditorsPath` |
66+
67+
### customUnityEditorsPath
68+
69+
Should you have configured `unityEditorsPathMode` to `specify`, this input is used to read your custom path.
70+
71+
| YAML | Classic Editor | Required | Default |
72+
|----------------------------|-------------------------------|----------|---------|
73+
| `customUnityEditorsPath` | Editors folder location | Yes, if `unityEditorsPathMode` is `specify` | - |
74+
75+
## Output variables
76+
77+
This task defines the following output variables, which you can consume in downstream steps, jobs, and stages.
78+
79+
### editorLogFilePath
80+
81+
Path to the Unity editor log file generated while executing the task.

0 commit comments

Comments
 (0)