How to conditionally execute SBT task

Question

I have an alternative way of completing an existing expensive task, though I don't know until runtime if I'll do it that way. (For example, a file cache.)

How do I do this?

For example, packageBin:

packageBin in Compile := Def.taskDyn {
  if (canDoItMyWay) {
    doItMyWayTask
  } else {
    Defaults.packageTask
  }
}.value

This doesn't work if it executes the latter path:

$ sbt packageBin
[trace] Stack trace suppressed: run last compile:packageBin for the full output.
[error] (util-2_10/compile:packageBin) sbt.Init$RuntimeUndefined: References to undefined settings at runtime.

gilad hoch · Answer 1 · 2015-03-25T09:53:20.263

0

the following works for me:

val canDoItMyWay: Boolean = ...

//regular method. Not a task
def doItMyWay: File = ...

packageBin in Compile := {
    if(canDoItMyWay) doItMyWay
    else (packageBin in Compile).value
}

no need to use dynamic tasks here. note that .value will only work in sbt 0.13+

also, note that I didn't use a special Task for it. just regular code. judging by the name: doItMyWayTask implies you defined a task. if you use a custom task, then:

is it needed? why a task? does it depends on other settings/tasks?
if it must be a task, make sure to not have cyclic dependency here, i.e. it should not depend on packageBin

edited Mar 25 '15 at 09:53

answered Mar 24 '15 at 07:39

gilad hoch

2,846
2
33
57

But doesn't that always execute the original packageBin in Compile task? My idea was to avoid it in some circumstances. – Paul Draper Mar 24 '15 at 17:08
No. Only if the condition doesn't hold. – gilad hoch Mar 24 '15 at 17:13
@PaulDraper I edited my answer. does this works for you? – gilad hoch Mar 25 '15 at 09:54

How to conditionally execute SBT task

1 Answers1