You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/00-introduction.md
+34-11Lines changed: 34 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,44 @@ title: Introduction
4
4
slug: /
5
5
---
6
6
7
-
Once Unity Tools for Azure DevOps has been installed to your organization, you'll have access to a set of
8
-
build and release tasks for Unity related operations. The extension provides the following tasks for use in your pipelines:
7
+
# Introduction to CI/CD Automation for Unity Projects
9
8
10
-
Please check each tasks documentation page and for examples on how to use them. Also make sure to checkout our [Examples](./examples.md) collection with useful pipeline definitions you can copy-paste and adjust to your needs.
9
+
Continuous Integration and Continuous Deployment (CI/CD) are pivotal in modern software development, ensuring that teams can build, test, and deliver applications efficiently and reliably. For Unity developers, adopting CI/CD workflows can significantly streamline the creation and distribution of games and interactive experiences, while minimizing risks and maximizing productivity.
11
10
12
-
## Build Tasks
11
+
This Azure DevOps extension was specifically designed to enhance the CI/CD process for Unity-based projects. Before diving into how to use the extension, let’s explore why CI/CD automation is important and how it benefits Unity developers.
13
12
14
-
-[Unity Build](unity-build-task.md)
15
-
-[Unity CMD](unity-cmd-task.md)
13
+
## Why CI/CD Automation Matters
16
14
17
-
## Testing Tasks
15
+
In traditional development workflows, building, testing, and deploying applications often involve manual steps that are time-consuming and error-prone. With CI/CD automation, these processes are streamlined and standardized, offering the following advantages:
18
16
19
-
-[Unity Test](unity-test-task.md)
17
+
1.**Faster Iterations:** Automated pipelines allow developers to focus on creating and refining features instead of spending time on manual builds and deployments. Changes can be integrated, tested, and deployed within minutes.
20
18
21
-
## Utility Tasks
19
+
2.**Improved Code Quality:** Continuous integration ensures that every change is tested as soon as it’s pushed to the repository. This immediate feedback loop helps identify bugs and regressions early in the development cycle.
-[Unity Get Project Version](unity-get-project-version-task.md)
21
+
3.**Enhanced Collaboration:** Teams can work more cohesively by integrating their changes frequently, reducing merge conflicts and maintaining a cleaner codebase.
22
+
23
+
4.**Consistent Builds:** Automation eliminates the inconsistencies that arise from manual builds, ensuring that the same process is followed every time a build is created.
24
+
25
+
5.**Reduced Risk:** By automating deployment, you reduce the likelihood of human error, leading to more reliable and predictable releases.
26
+
27
+
6.**Scalability:** As your Unity project grows, manual processes can quickly become unmanageable. CI/CD pipelines can handle the increased complexity, allowing your team to scale without bottlenecks.
28
+
29
+
## Benefits for Unity Developers
30
+
31
+
Unity projects pose unique challenges when it comes to CI/CD due to their reliance on specific project configurations, asset management, and platform-specific builds. This extension addresses these challenges and offers the following Unity-specific benefits:
32
+
33
+
1.**Automated Builds Across Platforms:** Unity projects often target multiple platforms, such as PC, console, mobile, and VR/AR devices. CI/CD pipelines can automate the build process for all target platforms, saving time and reducing errors.
34
+
35
+
2.**Seamless Asset Handling:** Unity projects include large assets that need to be properly managed and integrated into builds. Automation ensures that these assets are consistently processed and optimized.
36
+
37
+
3.**Improved Testing:** From unit tests to playmode tests, CI/CD pipelines can automate testing workflows to ensure that your project runs as expected across various configurations and platforms.
38
+
39
+
4.**Streamlined Distribution:** With automated pipelines, you can directly distribute builds to testers, stakeholders, or app stores, making the deployment process fast and hassle-free.
40
+
41
+
5.**Support for Collaboration:** Unity is often used by multidisciplinary teams comprising developers, artists, and designers. CI/CD workflows help ensure that all team members’ contributions are integrated smoothly, maintaining project stability.
42
+
43
+
## Conclusion
44
+
45
+
CI/CD automation isn’t just a convenience—it’s a necessity for modern Unity development. By adopting automated workflows, your team can unlock new levels of efficiency, quality, and scalability. This Azure DevOps extension is here to help you achieve these goals, providing tailored solutions for the unique needs of Unity projects.
46
+
47
+
In the following sections, we’ll guide you through setting up and using this extension to build powerful CI/CD pipelines tailored to your Unity projects. Let’s get started!
Copy file name to clipboardExpand all lines: docs/01-getting-started/01-installation.md
+3-40Lines changed: 3 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,51 +12,14 @@ This documentation assumes you have some knowledge of setting up pipelines using
12
12
13
13
:::
14
14
15
-
## What is it?
16
-
17
-
It's an extension to [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/) that adds build and release tasks specifially for [Unity](https://unity.com/) projects. That way it enables implementation of continuous integration and deployment pipelines for an improved workflow that saves time and money.
18
-
19
-
---
20
-
21
-
## How to install
22
-
23
15
The extension is published to the Visual Studio Marketplace and can be installed from there:
24
16
25
17
1. Open the extension [Unity Tools for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116) in the marketplace and select `Get it free` to start the installation process.
26
18
27
-

19
+

28
20
29
21
2. Select the Azure DevOps organization you want to install the extension to and proceed by selecting `Install`. *(You may also download the extension if you are using Azure DevOps Server).*
30
22
31
-

32
-
33
-
3. The extension is now installed and you are ready to create your first Unity pipeline.
34
-
35
-
---
36
-
37
-
## Supported Unity Versions
38
-
39
-
Unity Tools for Azure DevOps supports building Unity projects starting from `2017.2.0f1` up to the `latest release` of the Unity editor.
40
-
41
-
---
42
-
43
-
## Supported Agents
44
-
45
-
The extension generally supports Microsoft hosted agents as well as custom agents. Some features may not be available when using hosted agents for older Unity versions and platforms that require setting up e.g. specific SDKs on the machine for builds to work. In such cases, we recommend using a custom agent with full control over tools and software installed.
46
-
47
-
### Supported Platforms for Hosted Agents
48
-
49
-
- Standalone Windows
50
-
- Standalone macOS
51
-
- Standalone Linux
52
-
- Universal Windows Platform
53
-
54
-
:::caution
55
-
56
-
Please note that a Unity Plus / Pro seat with at least one available activation is required to build using hosted agents. This is a requirement by Unity not this extension. The agent will activate the seat on build and release it again once done.
57
-
58
-
:::
59
-
60
-
### Supported Platforms for Custom Agents
23
+

61
24
62
-
- All Unity Platforms supported
25
+
3. The extension is now installed and you are ready to create your first Unity pipeline.
Copy file name to clipboardExpand all lines: docs/01-getting-started/02-unity-support.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,17 @@
2
2
id: unity-support
3
3
title: Supported Unity Versions
4
4
sidebar_label: Supported Unity Versions
5
-
---
5
+
---
6
+
7
+
# Supported Unity versions
8
+
9
+
All included automation tasks in the extension have been tested and verified against the following Unity versions. Any other versions are not officially supported, they may or may not work.
10
+
11
+
| Unity Version | Supported | Notes |
12
+
|----------------|:---------:|-------|
13
+
| Unity 6 | ✅ ||
14
+
| Unity 2022 LTS | ✅ ||
15
+
| Unity 2021 LTS | ✅ ||
16
+
| Unity 2020 LTS | ✅ ||
17
+
| Unity 2019 LTS | ✅ ||
18
+
| Unity 2018 LTS | ✅⚠ | Support will be dropped with the next major release. Please consider updating your project to a newer Unity version. |
Copy file name to clipboardExpand all lines: docs/01-getting-started/03-agent-support.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,26 @@
2
2
id: agent-support
3
3
title: Supported Agents
4
4
sidebar_label: Supported Agents
5
-
---
5
+
---
6
+
7
+
# Supported agents
8
+
9
+
The extension generally supports Microsoft hosted agents as well as custom agents. Some features may not be available when using hosted agents for older Unity versions and platforms that require setting up e.g. specific SDKs on the machine for builds to work. In such cases, we recommend using a custom agent with full control over tools and software installed.
Microsoft hosted agents come with everything you need already set up. If you are setting up your own agent, do make sure it meets the following Software requirements.
19
+
20
+
| Software / SDK |
21
+
|----------------|
22
+
| Unity Hub |
23
+
| git |
24
+
25
+
:::info
26
+
Additional software or SDKs may be needed depending on the platform you are targeting with your build. The rule of thumb is, whatever you need to build your project on your own development machine, you'll need to make sure it is installed on the agent as well.
0 commit comments