-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # 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 <zkamvar@gmail.com>
Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
…_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):
![image](https://private-user-images.githubusercontent.com/5583057/363659440-61b63098-28cf-45bf-bbb2-7badd67ad106.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyMTY0NjUsIm5iZiI6MTczOTIxNjE2NSwicGF0aCI6Ii81NTgzMDU3LzM2MzY1OTQ0MC02MWI2MzA5OC0yOGNmLTQ1YmYtYmJiMi03YmFkZDY3YWQxMDYucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTBUMTkzNjA1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9OTcyMmJhMGNmZDI4YjhkMjBjZDM3NmM0NTZlNjg5NTMyMWJjZjVmNzcwODUzYzM2Zjc5MGI3NDE4OTUzMWY1NCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.l2XgIJUohkLFyBR-ctCO8vAzAUsDSY1Nt5UI9EggMEM)
TO THIS (where test results and symbols are correctly printed on new lines)
![image](https://private-user-images.githubusercontent.com/5583057/363659868-722c199a-ed88-47da-bc95-30ba2523c0b1.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyMTY0NjUsIm5iZiI6MTczOTIxNjE2NSwicGF0aCI6Ii81NTgzMDU3LzM2MzY1OTg2OC03MjJjMTk5YS1lZDg4LTQ3ZGEtYmM5NS0zMGJhMjUyM2MwYjEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTBUMTkzNjA1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZDEyZmNmNDFjMmNlNjQ3ZmVjNjhmYzg5NmJjNjA1YmQzODcxOTJiY2I5N2ViZGI2MWRmMjRmZmJhNDM4MGExMSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.kMckS22mBxuTIcWpXa1jCJxadJ-EwJnwuqgXMMaeh18)