Class BuildInfoBuildProcessor
A BuildInfo process step for the legacy build pipeline in Unity.
During the build process a BuildInfo file will be generated containing information passed in
through commandline arguments (parsed by CommandLineParser). These arguments and
their formats are configurable via the Config.
Inheritance
System.Object
BuildInfoBuildProcessor
Implements
UnityEditor.Build.IPreprocessBuildWithReport
UnityEditor.Build.IPostprocessBuildWithReport
UnityEditor.Build.IOrderedCallback
Namespace: GDX.Editor.Build
Syntax
public class BuildInfoBuildProcessor : IPreprocessBuildWithReport, IPostprocessBuildWithReport, IOrderedCallbackRemarks
After a build is finished, the BuildInfo will be reset to default values. This is intended to make sure
local builds have a specific marker.
| Argument (Default Value) | Description |
|---|---|
| BUILD | The build number, accessible through BuildInfo.BuildNumber. |
| BUILD_DESC |
A short description of the build (example: useful for identifying personal CI builds),
accessible through BuildInfo.Description.
|
| BUILD_CHANGELIST |
The changelist which the build was made against, accessible through
BuildInfo.Changelist.
|
| BUILD_TASK |
The name of the build script/task which was used to create the build (example:
CODE-Main-Build-PS5-Development), accessible through BuildInfo.BuildTask.
|
| BUILD_STREAM |
An indicator of what stream/branch that the build was build against from your chosen version
control system, accessible through BuildInfo.Stream.
|
Properties
| Improve this Doc View SourcecallbackOrder
The priority for the processor to be executed, before defaults.
Declaration
public int callbackOrder { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The numerical value used to sort callbacks, lowest to highest. |
Methods
| Improve this Doc View SourceOnPostprocessBuild(BuildReport)
Restores the default BuildInfo after a build process finishes.
Declaration
public void OnPostprocessBuild(BuildReport report)Parameters
| Type | Name | Description |
|---|---|---|
| UnityEditor.Build.Reporting.BuildReport | report | Build process reported information. |
OnPreprocessBuild(BuildReport)
Writes out BuildInfo prior to build.
Declaration
public void OnPreprocessBuild(BuildReport report)Parameters
| Type | Name | Description |
|---|---|---|
| UnityEditor.Build.Reporting.BuildReport | report | Build process reported information. |
Implements
UnityEditor.Build.IPreprocessBuildWithReport
UnityEditor.Build.IPostprocessBuildWithReport
UnityEditor.Build.IOrderedCallback