Build Runners
Build Runners define how a build step is executed inside BuildNinja. Each runner encapsulates a specific execution strategy, such as running shell commands, building .NET solutions, executing scripts, running tests, or performing operations on remote machines.
Instead of writing custom automation logic for every scenario, BuildNinja provides preconfigured runners optimized for common development and deployment workflows. Each runner exposes a set of parameters that control execution behavior, environment context, and error handling.
Using the appropriate runner improves build reliability, readability, and maintainability while ensuring consistent behavior across build configurations and environments.
What Build Runners Do
A build runner performs the following functions during a build:
- Executes a specific type of task, such as running commands, building projects, or executing tests.
- Controls the runtime environment, including the working directory, execution shell, and input parameters.
- Defines failure behavior and determines whether subsequent steps continue or stop.
- Standardizes how common actions such as builds, tests, deployments, and script execution are performed.
Build Runners Available in BuildNinja
BuildNinja provides the following build runners:
- Command Line RunnerThe Command Line Runner executes one or more shell or batch commands directly on the BuildNinja agent machine. It provides a flexible way to run command-line tools, scripts, and system utilities, making it well suited fo…
- Script RunnerThe Script Runner executes multi-line scripts using a selected shell or scripting environment. It supports complex logic, conditional execution, loops, and reusable automation, making it suitable for advanced build steps…
- Config File RunnerThe Config File Runner executes builds using a declarative YAML configuration file. It enables build logic to be version-controlled, reviewed, and reused consistently across projects and environments, promoting reproduci…
- MSBuild RunnerThe MSBuild Runner compiles and builds .NET projects and Visual Studio solution files using Microsoft’s MSBuild engine. It provides fine-grained control over build configurations, supports custom parameters, and integrat…
- VSTest RunnerThe VSTest Runner executes automated tests built with Visual Studio test frameworks and generates structured test reports for analysis and quality validation.
- SSH RunnerThe SSH Runner executes commands on a remote machine over Secure Shell (SSH). It enables secure remote automation for deployments, infrastructure management, and post-build operations.
Each runner is purpose-built for a specific category of workloads and tools, enabling teams to execute commands, build applications, run automated tests, perform remote operations, and automate complex workflows in a consistent and reliable manner.