How does one cancel a system groovy script

Question

In Jenkins I have a system groovy script build step. Is there any way to cancel a long running script, or to have some code within the system groovy script which can tell whether its build has been cancelled?

Answer 1

Jenkins will interrupt the thread which is running the script when you cancel the build.

So you can either manually check the thread's interrupt status and abort your script at certain points, eg

if (Thread.currentThread().interrupted()) {
  throw new InterruptedException()
}

Or you can let Groovy do that for you by including the ThreadInterrupt annotation in your script, eg

@groovy.transform.ThreadInterrupt

Also make sure that none of your catch blocks will swallow an InterruptedException.