https://github.com/rageagainstthepixel/unity-build

GitHub action to build a project using the OpenUPM build pipeline utilities
https://github.com/rageagainstthepixel/unity-build

game-ci github github-actions github-actions-unity unity

Last synced: 6 months ago
JSON representation

GitHub action to build a project using the OpenUPM build pipeline utilities

• Host: GitHub
• URL: https://github.com/rageagainstthepixel/unity-build
• Owner: RageAgainstThePixel
• License: mit
• Created: 2022-11-01T02:05:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T23:11:43.000Z (10 months ago)
• Last Synced: 2025-04-15T12:14:07.785Z (6 months ago)
• Topics: game-ci, github, github-actions, github-actions-unity, unity
• Homepage:
• Size: 32.2 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# 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](https://github.com/RageAgainstThePixel/com.utilities.buildpipeine) package from OpenUPM

[![openupm](https://img.shields.io/npm/v/com.utilities.buildpipeline?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.utilities.buildpipeline/)

## How to use

```yaml

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: RageAgainstThePixel/unity-setup@v1

        with:

          build-targets: ${{ matrix.build-target }}

      - name: Unity Build (${{ matrix.build-target }})

        uses: RageAgainstThePixel/unity-build@v8

        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](https://docs.unity3d.com/Manual/EditorCommandLineArguments.html) 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](https://docs.unity3d.com/Manual/EditorCommandLineArguments.html) to pass to test command. Default is ''.

- **`additional-validation-args:`** *Optional* Additional command line arguments to pass during project validation phase.

- **`artifact-name:`** *Optional* A name for this steps artifact.