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

Add an hc doctor command that checks if Hipcheck is ready to run #27

Open
alilleybrinker opened this issue Apr 23, 2024 · 3 comments · May be fixed by #81
Open

Add an hc doctor command that checks if Hipcheck is ready to run #27

alilleybrinker opened this issue Apr 23, 2024 · 3 comments · May be fixed by #81
Assignees
Labels
type: enhancement New feature or request
Milestone

Comments

@alilleybrinker
Copy link
Collaborator

Hipcheck requires some files to be present / findable by it in order to run. Currently, these are checked at the start of running Hipcheck, but it checks them one by one and doesn't give a convenient way to check the full readiness of Hipcheck to execute. While this can also be improved in the hc check flow, it would be nice to have a separate command that checks Hipcheck's readiness to run by looking for configuration, data files, and a place to put clones, and reports everything it finds. This would also help people to debug if they feel like Hipcheck found inferred the wrong location.

@alilleybrinker alilleybrinker added the type: enhancement New feature or request label Apr 23, 2024
@alilleybrinker alilleybrinker added this to the 3.2.0 milestone Apr 23, 2024
@alilleybrinker
Copy link
Collaborator Author

This could also support the deprecation of the --print-config, --print-data, --print-home flag commands, which is ideal. I don't really like that we've made it so some flags run commands instead.

@alilleybrinker
Copy link
Collaborator Author

The hc doctor command should also give instructions for fixing any problems it identifies, like missing helper scripts or lack of configuration files. This would also help ease the workflow of people installing just the Hipcheck binary through something like cargo binstall or an Axo install script in the future.

@alilleybrinker alilleybrinker self-assigned this Apr 23, 2024
@alilleybrinker
Copy link
Collaborator Author

Also open to a different name for this command.

@alilleybrinker alilleybrinker modified the milestones: 3.2.0, 3.3.0 Apr 29, 2024
@mchernicoff mchernicoff linked a pull request May 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants