unity-test-runner/README.md

2.3 KiB

Unity - Test runner

Actions status


GitHub Action to run tests for any Unity project.

Part of the Unity Actions collection.


This is a recommended step to prepare your pipeline for using the Build action.

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: Test project
on: [push]
jobs:
  testRunnerInAllModes:
    name: Test all modes ✨
    runs-on: ubuntu-latest
    steps:

Configure the test runner as follows:

# Configure test runner
- name: Run tests
  id: myTestStep
  uses: webbertakken/unity-test-runner@v1.1
  env:
    # Choose: "all", "playmode", "editmode"
    TEST_MODE: all

    # Optional: Path to your project, leave blank for "./"
    PROJECT_PATH: relative/path/to/your/project

    # Optional: Artifacts path, leave blank for "artifacts"
    ARTIFACTS_PATH: store/artifacts/here

You use the id to upload the artifacts like so:

# Upload artifacts
- name: Upload test results
  uses: actions/upload-artifact@v1
  with:
    name: Test results
    path: ${{ steps.myTestStep.outputs.artifactsPath }}

customParameters

Custom parameters to configure the test run.

Parameters must start with a hyphen (-) and may be followed by a value (without hyphen).

Parameters without a value will be considered booleans (with a value of true).

example:

- uses: webbertakken/unity-test-runner@master
  with:
    customParameters: -profile SomeProfile -someBoolean -someValue exampleValue

required: false default: ""

Save your workflow

Commit and push your workflow definition.

More actions

Visit Unity Actions to find related actions for Unity.

Feel free to contribute.

Licence

MIT