Document that stages w/o input are always considered out-of-date / are always rerun.

kevin-hanselman / dud

A lightweight CLI tool for versioning data alongside source code and building data pipelines.

https://kevin-hanselman.github.io/dud/

BSD 3-Clause "New" or "Revised" License

183 stars 8 forks source link

Document that stages w/o input are always considered out-of-date / are always rerun. #218

Closed RomeoV closed 2 months ago

RomeoV commented 2 months ago

It was not clear to me from the docs that stages without an input stage are always rerun, thus invalidating any downstream stages. I just spent half an hour debugging this, and haven't seen this documented clearly. Instead I found it here in the code: https://github.com/kevin-hanselman/dud/blob/1b99eff4946977c4774cfabc56de2a3f9fbfe2cb/src/index/run.go#L55-L58

I think it would be good do document it in the dud run docstring, as proposed in this PR.

kevin-hanselman commented 2 months ago

Thanks for the contribution! I was hoping that the runReason display text would help with this. Were you unable to see it for some reason?

RomeoV commented 2 months ago

The run reason were not displayed, neither when adding "--trace" nor the "--verbose" flag. I agree they would have surely helped. However, i think it's still worth documenting.

kevin-hanselman commented 2 months ago

The run reason were not displayed

What version of dud are you using?

RomeoV commented 2 months ago

Indeed I was on an old version (0.4.3). With 0.4.5, I get the output! Closing this PR then. Thanks!