insightsengineering / thevalidatoR

Github Action that generates R Package Validation documentation 🏁
https://github.com/marketplace/actions/r-package-validation-report
MIT License
57 stars 5 forks source link

Adding report generation dependencies to Dockerfile #11

Closed dgkf closed 3 years ago

dgkf commented 3 years ago

First, I didn't have the good sense to look at ongoing work before kicking this off, so some of it is a bit overlapping with @epijim's add/generator branch.

Changes

Considerations

I'm not totally comfortable with what directory structure we should assume gets mounted into the action container. I tested it assuming the repo contents get copied into the container's $HOME (/root). Nothing is hard coded around this assumption, but it hasn't been tested against anything else.

dgkf commented 3 years ago

Sorry for the commit spam :stuck_out_tongue:

Looks like remaining issues are in covtracer's ballpark. I'll have to dig into what error it's causing on that end. Otherwise I think this is working as intended.

dgkf commented 3 years ago

This sent me down the rabbit hole. This error can be managed in covtracer, but the root cause actually lies in a difference of behavior in rocker/verse images and its R setup.

I haven't traced it down entirely yet, but for whatever reason the tests aren't being sourced with preserved srcref information when covr runs in a rocker/verse image. This is different from the behavior on all of my local machines and rocker/tidyverse - even on the same R version and package versions. There must be R compile flag, environment variable or option that is configured somewhere changing this behavior.

Still trying to track it down to be more comprehensive in the template, but for the time being I'm going to try to add a safe fallback for this scenario to covtracer.