etiennebacher / altdoc

Alternative to pkgdown to document R packages
https://altdoc.etiennebacher.com
Other
62 stars 9 forks source link

Make `render_docs()` error if there are any rendering failures #238

Closed etiennebacher closed 8 months ago

etiennebacher commented 8 months ago

I think it's good that we delay the error until the end of render_docs() so that we can get the full list of failures, but in the end there should be an error.

For example, this workflow has plenty of failures but I had no idea: https://github.com/pola-rs/r-polars/actions/runs/7251398268/job/19753670691#step:10:258

vincentarelbundock commented 8 months ago

Not sure what the use case is, but counterpoint: My build takes 20 minutes. I like to see errors before the end if possible.

That said, I don't have super strong feelings about this.

etiennebacher commented 8 months ago

We can also error early. The thing is that since my build takes around 15min I rarely run the whole thing locally and I rather rely on the CI. When this is the case I want to see if multiple things failed so I can fix everything at once and avoid several push-and-wait-for-ci cycles. Could be an option fail_early = FALSE/TRUE?

In any case we should throw an error

vincentarelbundock commented 8 months ago

Nah, I think that's a really niche decision and not an important one. Just pick the default you want.

As long as I can do verbose=TRUE and monitor along the way, it should be fine.

Thanks!