Skip to content
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

Write an RFD for updating Hipcheck's output formats. #18

Open
alilleybrinker opened this issue Apr 8, 2024 · 0 comments
Open

Write an RFD for updating Hipcheck's output formats. #18

alilleybrinker opened this issue Apr 8, 2024 · 0 comments
Labels
status: needs-rfd This topic is big enough to require an RFD. type: enhancement New feature or request
Milestone

Comments

@alilleybrinker
Copy link
Collaborator

alilleybrinker commented Apr 8, 2024

Today Hipcheck supports two output formats, a JSON format and a human-readable format. Unfortunately, because it was added later and haphazardly, the JSON format does not include the full detail included in the human-readable output (technically, all the information is there, but without any of the helpful explanatory text included in the human-readable output, so it's usable only by the few Hipcheck experts around).

We want to bring these two into alignment, but we'll also need to grapple with what Hipcheck output should look like in the face of the new plugin system. This means assessing the output is at least in part dependent on the other RFDs around the redesign of Hipcheck's core architecture (#6, #10, #11, #12).

Once those are resolved, but likely before we've completed the implementation of the architecture update, we should write an RFD for Hipcheck's new outputs, addressing both what ought to be added / removed / changed to reflect the new architecture better, and how to make sure the two output formats are consistent with each other.

Relatedly, we'd had prior conversations with the folks involved in the Heimdall project about either adopting the Heimdall Data Format for Hipcheck's output, or collaborating to produce an adapter which could take Hipcheck's output and convert it into the Heimdall Data Format. This choice hasn't yet been resolved, and ideally the RFD would answer it one way or the other.

@alilleybrinker alilleybrinker added the type: enhancement New feature or request label Apr 8, 2024
@alilleybrinker alilleybrinker added this to the 3.4.0 milestone Apr 8, 2024
@alilleybrinker alilleybrinker added the status: needs-rfd This topic is big enough to require an RFD. label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: needs-rfd This topic is big enough to require an RFD. type: enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant