Build Automation

Create and run build tasks using a standard programming interface
Since R2022b

Use the build tool to create and run build tasks, such as identifying code issues, running tests, and packaging a toolbox.

You can create a plan with your tasks and task dependencies in a single build file, and then invoke the build tool to run the plan. To get started, see Overview of MATLAB Build Tool.

Functions

`buildtool`	Invoke build tool
`buildplan`	Create build plan

Classes

expand all

Build Definition

`matlab.buildtool.Plan`	Fundamental interface for defining a build
`matlab.buildtool.Task`	Single unit of work in a build
`matlab.buildtool.TaskGroup`	Group of similar tasks (Since R2024b)
`matlab.buildtool.TaskAction`	Action performed when task runs
`matlab.buildtool.TaskContext`	Context provided when task runs
`matlab.buildtool.TaskResult`	Result of running a task
`matlab.buildtool.BuildResult`	Result of running a build

Task Inputs and Outputs

`matlab.buildtool.TaskInputs`	Container for task inputs (Since R2023b)
`matlab.buildtool.TaskOutputs`	Container for task outputs (Since R2023b)
`matlab.buildtool.io.FileCollection`	Collection of files and folders (Since R2023a)
`matlab.buildtool.io.File`	Single file or folder (Since R2023b)
`matlab.buildtool.io.Glob`	File collection that matches pattern (Since R2023b)

Built-In Tasks

`matlab.buildtool.tasks.CleanTask`	Task for deleting outputs and traces (Since R2023b)
`matlab.buildtool.tasks.CodeIssuesTask`	Task for identifying code issues (Since R2023b)
`matlab.buildtool.tasks.MexTask`	Task for building MEX file (Since R2024a)
`matlab.buildtool.tasks.PcodeTask`	Task for creating P-code files (Since R2024a)
`matlab.buildtool.tasks.TestTask`	Task for running tests (Since R2023b)

Topics

Overview of MATLAB Build Tool
Use the build tool to define and run a build.
Create and Run Tasks Using Build Tool
Create a plan using a main function and a local task function in a build file. Then, plot dependencies and run the tasks with the build tool.
Create Tasks That Accept Arguments
Create build tasks that accept arguments for customizing their actions. Then, run the tasks with the build tool. (Since R2023a)
Create Groups of Similar Tasks
Create and run a group of related tasks that act as a single unit of work in the build tool. (Since R2024b)
Improve Performance with Incremental Builds
Run builds more efficiently by specifying task inputs and outputs. (Since R2023a)

How useful was this information?

Unrated 1 star 2 stars 3 stars 4 stars 5 stars