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.
✖ : check_failure class object.
ⓧ : check_error class object. This also indicates early termination of the validation process.
☒ : check_exec_error class object. This indicates an error in the execution of a check function.
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):
TO THIS (where test results and symbols are correctly printed on new lines)
check_failure
elevated to errorTo 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 ofhub_validation
objects, the following custom bullets have been assigned to the print-outcli
theme.✖
:check_failure
class object.ⓧ
:check_error
class object. This also indicates early termination of the validation process.☒
:check_exec_error
class object. This indicates an error in the execution of a check function.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:Everything prints much better on our documentation site now though:
THIS (where the check results are squased into a single line):
TO THIS (where test results and symbols are correctly printed on new lines)