-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change check fail class and print method #114
Conversation
… aspect. Related to #111
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm all for this! I made a couple of suggestions on order and wording, but they are non-blocking.
I'm especially in favor of removing the octolog dependency (though this might be my "not built here" disease flaring up). I think if we want to use it, it would be a good idea to create a fork, add it to our universe, and modify it to actually work for us (e.g. have it respect the IN_PKGDOWN
envvar).
Co-authored-by: Zhian N. Kamvar <[email protected]>
Co-authored-by: Zhian N. Kamvar <[email protected]>
…_validations. Resolves #76
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fantastic--thanks, @annakrystalli!
Improve `hub_validations` print method
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)