Documentation

Support

Unity Cloud

Get Started

Asset Manager SDKs and services

Open Unity Dashboard

Unity Cloud

Create a pipeline

How to create a pipeline using Unity Pipeline Automation.
Read time 3 minutesLast updated 6 months ago
You can create a pipeline that performs a set of actions in your development process when triggered. You can automate pipelines to reduce repetitive tasks, minimize human errors, and scale operations.
Important
Only users with the Automation Developer role can create pipelines.
To create a pipeline:

1. Add pipeline details

  1. Sign in to your Unity Dashboard account.
  2. In the side navigation bar, select Pipeline Automation > Pipelines.
  3. Select + Create pipeline. A pipeline builder and Pipeline Details panel open.
  4. In the Pipeline Details tab, enter a name and description for your pipeline. You can view this information when the pipeline runs and while viewing jobs.
Note
Ensure that the name and description provide enough context for users to understand the pipeline's purpose and the expected outcome of running it.

2. Create a pipeline parameter

Pipeline parameters are predefined values passed when a pipeline runs. Action inputs can reference these parameters, so pipelines can accept dynamic values. This makes them reusable and adaptable to different scenarios.
Warning
This product allows you to input developer defined data (such as custom inputs, metadata, and assets). You must not use the product to input or collect personal data, unless such information is specifically required or requested by Unity.
There are two ways to create a pipeline parameter:

2.1 From an action input parameter

You can create a pipeline parameter from an action input parameter. All information from the action input parameter is copied into the new pipeline parameter. You can edit the information if required. To create a pipeline parameter from an action input parameter:
  1. In the pipeline builder, select the step containing the action input parameter you want to reference for your pipeline parameter.
  2. In the side panel, expand Inputs section.
  3. Select the + button on top of the action input parameter you want.
  4. Select Add as parameter. The Add parameter dialog opens.
  5. Configure the parameter as needed.
  6. Select Add.

2.2 From Pipeline Details

You can create a pipeline parameter from the Pipeline Details tab. It involves more steps and is recommended for advanced users comfortable with data types. To create a new parameter from the Pipeline Details tab:
  1. At the bottom of the Pipeline Details tab, select + Add parameter.
  2. Configure the parameter as needed.
  3. Select Add.
For more information on fields in pipeline parameter configuration, see Pipeline parameter configuration.

3. Add a step

Pipelines consist of steps. A step typically runs an action from an app and specifies how and when to run it. Steps can also be used to run other pipelines or suspend the pipeline until resumed by a user.
Note
New pipelines by default have a step that has not been configured yet.
There are two ways to add a step to a pipeline:

3.1 Add a step with no dependencies

To add a step to the start of the pipeline:
  1. In the pipeline builder, on the top right corner, select the + button. The Select an action from an app dialog opens.
  2. Select an app.
  3. Select an action.
  4. Select Add Action.
The new action is added in parallel to existing steps.
Note
You can add multiple steps that run in parallel at the start with no dependent steps.

3.2 Add a step with dependencies

  1. In the pipeline builder, go to the step below which you want your new step.
  2. Select the + button. The Select an action from an app dialog opens.
  3. Select an app.
  4. Select an action.
  5. Select Add Action.
The new action is added below an existing step. For more information on steps, see Pipeline steps.
Note
To save a pipeline, you must have at least one fully configured step.

4. Name the step (optional)

5. Configure Dependencies (optional)

6. Configure Resources (optional)

7. Configure Secrets

8. Configure Inputs

9. Save your pipeline

Warning
The pipeline builder does not currently support saving incomplete pipelines. You will lose your changes if you leave the pipeline builder before you save.
To save a pipeline:
  1. All the following required fields and conditions must be completed:
  • Pipeline Details tab
    • Pipeline name
    • Pipeline description
  • Steps
    • All required action inputs
    • All required action secrets
    • No references to parameters that have been deleted
    • No dependencies on steps that have been deleted
  1. Once all the required information has been provided, select Create.
Your pipeline is saved and you are redirected to the pipelines page where you can run the pipeline.
Note
If there is an issue with any field or step, it is marked with a warning symbol. You need to see green checkmarks for both tabs and the components within the tabs to save the pipeline.