unity-build's Introduction

Unity Build Pipeline

A GitHub Action that builds Unity based projects.

Warning

This action requires that your Unity project be setup and using the com.utilities.buildpipeine package from OpenUPM

How to use

name: Unity Build

on:
  push:
    branches:
      - 'main'
  pull_request:
    branches:
      - '*'

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: windows-latest
            build-target: StandaloneWindows64
          - os: macos-latest
            build-target: StandaloneOSX
          - os: ubuntu-latest
            build-target: StandaloneLinux64

    steps:
      - uses: actions/checkout@v4

        # Installs the Unity Editor based on your project version text file
        # sets -> env.UNITY_EDITOR_PATH
        # sets -> env.UNITY_PROJECT_PATH
        # https://github.com/XRTK/unity-setup
      - uses: xrtk/unity-setup@v7
        with:
          build-targets: ${{ matrix.build-target }}

      - name: Unity Build (${{ matrix.build-target }})
        uses: RageAgainstThePixel/unity-build@v7
        with:
          build-target: ${{ matrix.build-target }}

Inputs

This action has the following input parameters:

build-target: Required. The build target to build for. Unity -buildTarget command line args Unity CommandLineArguments. StandaloneWindows64, WSAPlayer, StandaloneOSX, iOS, StandaloneLinux64, Android, Lumin, WebGL. Default is ''.
additional-build-args: Optional. Additional command line arguments to pass to build command. Default is ''.
output-directory: Optional. The directory to output the build to. Default is ''.
publish-artifacts: Optional. Should the workflow publish artifacts? Default is true.
test: Optional. Run editor tests. Default is true.
additional-test-args: Optional Additional command line arguments to pass to test command. Default is ''.

Recommend Projects