NAME [edit section]

= NAME =
abort_job

SYNOPSIS [edit section]

= SYNOPSIS =
 * abort_job ["<reason_string"]

DESCRIPTION [edit section]

= DESCRIPTION =
This function aborts the current job, printing the reason-string to the console.

The reason string is prefixed with: "Fuego error reason:"

Note that this uses the Jenkins web interface to abort the job, using the wget program.

EXAMPLES [edit section]

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    abort_job "$1 is not defined. Make sure you use correct overlay with required specs for this test/benchmark"
}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
This function uses:
 * BUILD_URL - to construct the URL to issue a command to Jenkins for this job

RETURN [edit section]

= RETURN =
Does not return.

SOURCE [edit section]

= SOURCE =
Located in ''scripts/common.sh''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_build_error|build_error]], [[function_assert_define|assert_define]]