step-security/Unity - Builder

Build Unity projects for different platforms.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
targetPlatformPlatform that the build should target.yes""
unityVersionVersion of unity to use for building the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txtnoauto
customImageSpecific docker image that should be used for building the projectno""
projectPathPath to the project to be built, relative to the repository root.no""
buildProfilePath to the build profile to activate, relative to the project root.no""
buildNameName of the build. Should not include a file extension.no""
buildsPathPath where the builds should be stored.no""
buildMethodPath to a Namespace.Class.StaticMethod to run to perform the build.no""
manualExitSuppresses `-quit`. Exit your build method using `EditorApplication.Exit(0)` instead.no""
enableGpuLaunches unity without specifying `-nographics`.no""
customParametersCustom parameters to configure the build.no""
useHostNetworkInitialises Docker using the host network. (Linux only)nofalse
versioningThe versioning scheme to use when building the projectnoSemantic
versionThe version, when used with the "Custom" versioning schemeno""
androidVersionCodeThe android versionCodeno""
androidExportTypeThe android export type. Should be androidPackage for apk, androidAppBundle for aab, or androidStudioProject for an android studio project.noandroidPackage
androidKeystoreNameThe android keystoreNameno""
androidKeystoreBase64The base64 contents of the android keystore fileno""
androidKeystorePassThe android keystorePassno""
androidKeyaliasNameThe android keyaliasNameno""
androidKeyaliasPassThe android keyaliasPassno""
androidTargetSdkVersionThe android target API level.no""
androidSymbolTypeThe android symbol type to export. Should be "none", "public" or "debugging".nonone
sshAgentSSH Agent path to forward to the containerno""
sshPublicKeysDirectoryPathPath to a directory containing SSH public keys to forward to the container.no""
gitPrivateTokenGithub private token to pull from githubno""
providerStrategyBuild execution strategy. Use "local" for local Docker/Mac builds. For remote builds (aws, k8s, etc.), install @game-ci/orchestrator and use the game-ci/orchestrator action which declares its own inputs.nolocal
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
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
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
allowDirtyBuildAllows the branch of the build to be dirty, and still generate the build.no""
cacheUnityInstallationOnMacWhether to cache the Unity hub and editor installation on MacOSnofalse
unityHubVersionOnMacThe version of Unity Hub to install on MacOS (e.g. 3.4.0). Defaults to latest available on brew if empty string or nothing is specified.no""
unityLicensingServerThe Unity licensing server address to use for activating Unity.no""
dockerWorkspacePathThe path to mount the workspace inside the docker container. For windows, leave out the drive letter. For example c:/github/workspace should be defined as /github/workspaceno/github/workspace
skipActivationSkip the activation/deactivation of Unity. This assumes Unity is already activated.nofalse
linux64RemoveExecutableExtensionWhen building for StandaloneLinux64, remove the default file extension of `.x86_64`. Set to true to restore the extensionless behavior from v4.nofalse
namedescription
volumeThe Persistent Volume (PV) where the build artifacts have been stored by Kubernetes
buildVersionThe generated version used for the Unity build
androidVersionCodeThe generated versionCode used for the Android Unity build
engineExitCodeReturns the exit code from the build scripts. This code is 0 if the build was successful. If there was an error during activation, the code is from the activation step. If activation is successful, the code is from the project build step.