Skip to main content

Actions and Logging

Build Assistant includes a number of built-in actions that are available without any additional plugins.

Built-in Actions​

  • BA_BuildAddressables - Build all addressable assets
  • BA_CopyFile - Copies a file from one location to another
  • BA_InjectBuildInfo - Inject custom key/value data into runtime build info (see Runtime)
  • BA_InjectGITDetails - Inject GIT_BRANCH and GIT_REVISION into runtime build info
  • BA_InjectSVNDetails - Inject SVN_BRANCH and SVN_REVISION into runtime build info
  • BA_ShowHideSplash - Enables or disables the custom splash for the current build
  • BA_ZipFiles - Zips and names a folder. Includes filtering options. Batch override: -ZipPathOverride

When to run​

Every action has a When to run foldout. Use it to decide whether that action runs from the editor, from batch mode, or only when a launch flag is present.

  • Run in Editor: The action runs when you press Build in the inspector or the Build Config Browser
  • Run in Batch Mode: The action runs during a command-line / CI build
  • Required batch flag: If this is set, the action only runs in batch when that flag is on the command line. Leave it empty to run every batch build.
When to run foldout on an action

Logging​

By default, Build Assistant logs build progress and output to the Unity Console or terminal. Logging can be extended with logger plugins to send build updates to external services. Loggers are enabled from Project SettingsBuild Assistant, not added as actions on a config.

Available Loggers:

Plugins​

Additional features are available through plugins, including:

See the Plugins section for package names and Package Manager install steps for each plugin.

If you require support for a platform or service which is not included, see Extending Build Assistant. Import the Example Plugin sample from Package Manager for a starting point.