unity-builder/README.md

Unity - Builder

---

GitHub Action to build Unity projects for different platforms.

Part of the Unity Actions collection.

---

Github Action to build Unity projects for different platforms.

It is recommended to run the Test action from the Unity Actions collection before running this action. This action also requires the Activation step.

Documentation

See the Unity Actions collection repository for workflow documentation and reference implementation.

Usage

Create or edit the file called .github/workflows/main.yml and add a job to it.

name: Build project
on: [push]
jobs:
  buildForWebGL:
    name: Build for WebGL 🕸
    runs-on: ubuntu-latest
    steps:

Activate Unity in a step using the Unity Activate action.

Configure the builder as follows:

      # Configure builder
      - name: Build project
        id: buildStep
        uses: webbertakken/unity-builder@v0.2 # WIP (only webgl for now)
        env:  
          # Optional: Path to your project, leave blank for "./"
          UNITY_PROJECT_PATH: path/to/your/project

          # Name for your build
          BUILD_NAME: TestBuild

          # Optional: Builds path, leave blank for "build"
          BUILDS_PATH: build

          # Target platform for your build
          BUILD_TARGET: WebGL

          # Optional: <StaticBuildClass.StaticMethod> 
          BUILD_METHOD: ""

Note: By default the enabled scenes from the project's settings will be built.

You use the id to upload your built files like so:

      # Upload distributables
      - name: Upload Build
        uses: actions/upload-artifact@v1
        with:
          name: Build
          path: ${{ steps.buildStep.outputs.allBuildsPath }}

Return the Unity license in a final step using the Unity Return License action.

Commit and push your workflow definition.

More actions

Visit Unity Actions to find related actions for Unity.

Feel free to contribute.

Licence

MIT