hubverse-org / hubValidations

Testing framework for hubverse hub validations
https://hubverse-org.github.io/hubValidations/
Other
1 stars 4 forks source link

Change check fail class and print method #114

Closed annakrystalli closed 1 month ago

annakrystalli commented 1 month ago

check_failure elevated to error

To make clearer that all checks, including those resulting in a check_failure, are required to pass for files to be considered valid, check_failure class objects are elevated to errors (#111). Also, to make it easier for users to identify errors from visually scanning the printed output of hub_validation objects, the following custom bullets have been assigned to the print-out cli theme.

Remove Octolog dependency

I also took the opportunity to remove the octolog dependency. This removes the annotation of validation results onto GitHub Action workflow logs (#113). Context:

I had been using octolog to wrap cli messages so that results of validations are returned on the GitHub Action page as annotations at the bottom of the workflow log.

It wasn't really working great, nor being used and octolog is still only available on GitHub with no known CRAN release date, I'm going to remove it as a dependency.

Everything prints much better on our documentation site now though:

THIS (where the check results are squased into a single line):

image

TO THIS (where test results and symbols are correctly printed on new lines)

image
github-actions[bot] commented 1 month ago

🚀 Deployed on https://66d9654c6f1557de07d7e4b5--hubvalidations-pr-previews.netlify.app

annakrystalli commented 1 month ago

Thanks for the review @zkamvar ! I've committed some suggestions or adapted them. Will wait for @bsweger's input too.