When true, a JSON representation of the build graph (as provided by the corresponding coordinator) is left on disk for debugging purposes. Defaults to false.
When true, node_modules
directory becomes read-only. This allows for extra build discipline enforcements, since tools are not supposed to write under this directory. This option is not on by default since there are some well-known tools that place cache folders under node_modules
.
Defines the policy to apply when two pips write to the same file. By default, same-content writes are allowed, and different-content ones are blocked. The options are:
type DoubleWritePolicy =
// double writes are blocked
"doubleWritesAreErrors" |
// double writes are allowed as long as the file content is the same
"allowSameContentDoubleWrites" |
// double writes are allowed, and the first process writing the output will (non-deterministically)
// win the race. Consider this will result in a non-deterministic deployment for a given build, and is therefore unsafe.
"unsafeFirstDoubleWriteWins";
When true, any tool that writes to standard error, even if the execution returns a successful exit code, will be interpreted as failed by BuildXL. For example, this is useful for the case of linting, where depending on whether a build is a release build, linter errors determine build success. Defaults to false.
Lists process names that are allowed to escape BuildXL sandbox, and therefore won't be monitored, nor their actions registered. This is an unsafe option. Please check here for details.
Allows to customize the available scripts for a given package. Check the details here.
Exit codes that are considered successful. Any exit code outside the provided list is considered a failed execution, and BuildXL will treat it as a build breaker. This configuration applies to all pips scheduled by the corresponding resolver.
Exit codes that cause BuildXL to retry the pip. By default this value is empty. If an exit code is also in 'successExitCode', then the pip is not retried on exiting with that exit code. This configuration applies to all pips scheduled by the corresponding resolver. The maximum number of retries is bound by 'processRetries'.
Maximum number of retries for processes. A process returning an exit code specified in 'retryExitCodes' will be retried at most the specified number of times. By default this value is not specified, in which case the build global max retry configuration defines this value (configured via command line arguments with /processRetries:n). If the global configuration is not specified, the default is 0, which implies that no retries will be attempted.
By default JavaScript projects can liberally read any source file on disk. BuildXL will only make sure these files are not treated in a racy manner (e.g. they are both rewritten and read by different pips in a non-deterministic order). By enabling this setting, pips are only allowed to read sources under package roots to which there is an explicitly dependency declared (or is in its transitive closure). When a pip reads a source file outside of the allowed scopes, a read DFA will be issued. Additional read scopes can be configured with additionalSourceReadsScopes
. Defaults to false.
A list of timeouts that apply to selected JavaScript projects. JavaScriptProjectTimeout definition is:
interface JavaScriptProjectTimeout {
timeout?: string;
warningTimeout?: string;
projectSelector: JavaScriptProjectSelector[];
}
Check the resolver configuration settings for the full definition.
The order in which timeouts are applied to projects matters. If a project is selected multiple times, the last selection will be the one that takes effect.
Make sure timeout
and warningTimeout
are correctly formatted string. Invalid format will cause build failure. The argument allows an expression that represents a time duration, like 3s
, 500ms
, 30m
, 1.5h
. The allowed suffixes are ms
, s
, m
, h
, and no suffix is interpreted as an amount in milliseconds. In addition, If not provided, the error and warning timeouts will be set to their default values.
Regex that would be used to extract warnings from the output.
Regex that would be used to extract errors from the output.