Raise Error Syntax

[jharbison]

I'm looking to trigger a deployment failure at the beginning of a plan if a user-provided variable isn't valid. Based on the documentation here https://inedo.com/support/documentation/buildmaster/execution-engine/statements-and-blocks/other-statements it looks like there is a raise error command for this purpose however I can't seem to find any documentation on how to use it. What is the proper way to trigger a fatal error in a plan?

Product: BuildMaster
Version: 5.6.8

[Dean]

I believe you want the fail statement. It will terminate the plan and will not run any catch blocks. So, something like this:

if $FailingCondition
{
  Log-Error Something bad happened!;
  fail;
}

[Josh]

That is exactly what I was looking for. Thank you.