Skip to content

Add "checkup" or "doctor" option to gp command line #12893

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

Open
david-bakin opened this issue Sep 12, 2022 · 3 comments
Open

Add "checkup" or "doctor" option to gp command line #12893

david-bakin opened this issue Sep 12, 2022 · 3 comments
Labels

Comments

@david-bakin
Copy link

Add a command checkup to the gp tool that does some basic "diagnostics"/"troubleshooting"/"sanity checks" on the workspace/repo.

For example:

  • Does it have a .gitpod.yml?
    • If not, does it have something else that might be a .gitpod.yml, e.g., gitpod.yml or .gitpod.yaml?
    • If so, does it syntax check? Any unknown attributes? Anything else that can be detected that is wrong about it?
      • E.g., it references an image: image doesn't exist. It references a custom dockerfile: that doesn't exist. It references a vscode extension: that extension doesn't exist at open-vsx.
      • E.g., it looks like it is trying to put something under /home/gitpod in an init: start task section (!! extra credit !!)
      • Are duplicate ports specified?
      • If there's an additionalRepositories key do the named repos exist?
      • If there's a mainConfiguration key does the named repo exist and have a .gitpod.yml pointing back to this repo?
  • Does it have a custom dockerfile?
    • Does it syntax check?
    • Is there something that looks like it could be a custom dockerfile (.e.g, a file named .gitpod.Dockerfile per the documentation examples) but it isn't mentioned in the .gitpod.yml? (Or there isn't a .gitpod.yml?)
    • Does it look like the custom dockerfile is trying to put stuff under /workspace?
  • Look in start task logs, the dotfile repo log, to find problems
    • task errored out on last run
    • task timed out on last run
  • How big is the workspace relative to the resource limits (mainly, but probably not exclusively, max size of the backup archive)

Etc. etc. Goal is to help a gitpod user (especially, but not only, new users) quickly get on board and/or fix problems that are impacting them.


  • (checkup is what it is called in the scoop command line tool, for example - probably others too.)
  • (doctor is what it is called in the brew command line tool, for example.)
@axonasif
Copy link
Member

Probably related with #7671

@axonasif
Copy link
Member

axonasif commented Oct 1, 2022

@david-bakin I would suggest to share your ideas from here to #9025, as both seems to be the same issue 😄

@stale
Copy link

stale bot commented Jan 2, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the meta: stale This issue/PR is stale and will be closed soon label Jan 2, 2023
@stale stale bot removed the meta: stale This issue/PR is stale and will be closed soon label Jan 8, 2023
@loujaybee loujaybee added the meta: never-stale This issue can never become stale label Feb 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants