IPostprocessBuildWithReport

Description

Implement this interface to execute code immediately after the Player build process is completed.

This is useful for tasks that need to be performed as the last step of building, such as cleaning up assets, generating analytics or reports, or customizing build outputs.

As a final step of a Player build, Unity uses the IOrderedCallback.callbackOrder property on each implementation to determine the order in which to invoke the callbacks.

Additional resources: IPreprocessBuildWithReport, BuildPipeline.BuildPlayer.

using System.Linq;
using System.Text;
using UnityEditor.Build;
using UnityEditor.Build.Reporting;
using UnityEngine;

// To try this example add this code into an Editor-only assembly,
// run a Player build, and then look for the message in the console.
// Note: if the build fails or is cancelled then the code will not run.
class BuildPostProcessor : IPostprocessBuildWithReport
{
    public int callbackOrder { get { return 100; } }
    public void OnPostprocessBuild(BuildReport report)
    {
        // Log some information from the BuildReport
        // Note: OnPostprocessBuild callbacks are invoked before the build is complete.
        // So the content of the BuildReport is not completely finalized.
        // For example, the summary.buildEndedAt has not been be determined,
        // and the incomplete "parent" BuildSteps still report 0 for their durations.
        var summary = report.summary;

        var files = report.GetFiles();
        ulong size = 0;
        foreach (var file in files)
            size += file.size;

        var sb = new StringBuilder();
        sb.AppendLine("Build completed");
        sb.AppendLine($"  Target: {summary.platform}");
        sb.AppendLine($"  Output Location: {summary.outputPath}");
        sb.AppendLine($"  Number of output files: {files.Length}");
        sb.AppendLine($"  Total size in bytes: {size}");
        sb.AppendLine($"  Starting time: {summary.buildStartedAt.ToLocalTime().ToShortTimeString()}");
        sb.AppendLine();

        var buildSteps = report.steps;
        sb.AppendLine($"Build steps: {buildSteps.Length}");
        int maxWidth = buildSteps.Max(s => s.name.Length + s.depth) + 2;
        foreach (var step in buildSteps)
        {
            string rawStepOutput = new string('-', step.depth) + ' ' + step.name;
            sb.AppendLine($"{rawStepOutput.PadRight(maxWidth)}: {step.duration:g}");
        }

        Debug.Log(sb.ToString());
    }
}

Public Methods