actions-marketplace-validations/Unity - Test runner

Run tests for any Unity project.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
unityVersionVersion of unity to use for testing the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt. ⚠️ If testing a Unity Package, this field is required and cannot be set to "auto".noauto
customImageSpecific docker image that should be used for testing the project. If packageMode is true, this image must have jq installed.no""
projectPathPath to the Unity project or package to be tested.no
customParametersExtra parameters to configure the Unity editor run.no
testModeThe type of tests to be run by the test runner.noall
coverageOptionsOptional coverage parameters for the -coverageOptions argument. To get coverage in Package Mode, pass assemblies from the package you want covered to the assemblyFilters option.nogenerateAdditionalMetrics;generateHtmlReport;generateBadgeReport;dontClear
artifactsPathPath where test artifacts should be stored.noartifacts
useHostNetworkInitialises Docker using the host network.nofalse
sshAgentSSH Agent path to forward to the container.no""
sshPublicKeysDirectoryPathPath to a directory containing SSH public keys to forward to the container.no""
gitPrivateTokenGitHub Private Access Token (PAT) to pull from GitHub.no""
githubTokenToken to authorize access to the GitHub REST API. If provided, a check run will be created with the test results.no""
checkNameName for the check run that is created when a github token is provided.noTest Results
packageModeWhether the tests are being run for a Unity package instead of a Unity project. If true, the action can only be run on Linux runners, and any custom docker image passed to this action must have `jq` installed. NOTE: may not work properly for packages with dependencies outside of the Unity Registry.nofalse
scopedRegistryUrlScoped registry to use for resolving package dependencies. Only applicable if packageMode is true.no""
registryScopesRegistry scopes to use for resolving package dependencies. Only applicable if packageMode is true. Required if scopedRegistry is set.no""
chownFilesToUser and optionally group (user or user:group or uid:gid) to give ownership of the resulting build artifactsno""
dockerCpuLimitNumber of CPU cores to assign the docker container. Defaults to all available cores on all platforms.no""
dockerMemoryLimitAmount of memory to assign the docker container. Defaults to 95% of total system memory rounded down to the nearest megabyte on Linux and 80% on Windows. On unrecognized platforms, defaults to 75% of total system memory. To manually specify a value, use the format <number><unit>, where unit is either m or g. ie: 512m = 512 megabytesno""
dockerIsolationModeIsolation mode to use for the docker container. Can be one of process, hyperv, or default. Default will pick the default mode as described by Microsoft where server versions use process and desktop versions use hyperv. Only applicable on Windowsnodefault
unityLicensingServerUrl to a unity license server for acquiring floating licenses.no""
containerRegistryRepositoryContainer registry and repository to pull image from. Only applicable if customImage is not set.nounityci/editor
containerRegistryImageVersionContainer registry image version. Only applicable if customImage is not set.no3
runAsHostUserWhether to run as a user that matches the host system or the default root container user. Only applicable to Linux hosts and containers. This is useful for fixing permission errors on Self-Hosted runners.nofalse
namedescription
artifactsPathPath where the artifacts are stored.
coveragePathPath where the code coverage results are stored.