search

ropensci-review-tools / pkgcheck

Check whether a package is ready for submission to rOpenSci's peer-review system
https://docs.ropensci.org/pkgcheck/
18 stars 6 forks source link

pkgcheck misses GitHub actions CI checks #87

Closed noamross closed 3 years ago

noamross commented 3 years ago

In https://github.com/ropensci/software-review/issues/470#issuecomment-937980756 , we seem to miss the checks implemented at https://github.com/ewallace/tidyqpcr/actions

maelle commented 3 years ago

Interesting, it's because there is no GHA badge in the README.

@mpadge should the instructions in the dev guide be clearer (badge compulsory) or should pkgcheck look for config files?

maelle commented 3 years ago

Or clearer instructions in dev guide + more informative failure message in pkgcheck.

mpadge commented 3 years ago

@noamross @maelle That check was wrapped in a double layer:

pass <- if (badges_pass)
if (pass & has_github_workflow)
  pass <- workflow_success

That meant the check failed if there were no badges. It has now been modified to:

pass <- if (badges_pass)
if (!pass & has_github_workflow)
  pass <- workflow_success

That now means that badges are not required for pkgcheck to pass. Happy to revert once we've tightened up devguide wording, but until then happy to keep this closed, and workflow results will be picked up independent of presence of badges.

maelle commented 3 years ago

Perfect, thanks. I'm actually leaning towards not encouraging badges more than present. (My opinion might change based on e.g. https://github.com/r-lib/pkgdown/issues/1299)

mpadge commented 3 years ago

Yeah, i think this solution is both fine and minimally invasive. Any extra requirements from our side only make things more difficult for submitters. Better for reviewers to pick up things like missing badges along the way.