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 positional arguments to CLI usage string #1467

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

lentzi90
Copy link
Contributor

Positional arguments like the machine name or provider name are undocumented in the CLI. This commit adds them to the "Use" string so that they show up with the --help flag.

@lentzi90
Copy link
Contributor Author

Related to #1391 and #1392

Copy link
Member

@pascalbreuninger pascalbreuninger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lentzi90 LGTM, thanks for the contribution

@lentzi90
Copy link
Contributor Author

The test failure does not look related. Is there a way to rerun?

 08:58:14 info Successfully removed DevPod container from server
WARN: remove C:\Windows\SystemTemp\temp-1792130308: The process cannot access the file because it is being used by another process.
+08:58:15 fatal cannot delete provider 'docker', because workspace 'temp-782768844' is still using it. Please delete the workspace 'temp-782768844' before deleting the provider
08:58:15 fatal provider docker already exists. Please run 'devpod provider delete docker' before adding the provider
WARN: remove C:\Windows\SystemTemp\temp-3626425215: The process cannot access the file because it is being used by another process.

------------------------------
+ [FAILED] [0.391 seconds]
[build] devpod build test suite testing build [It] should build image without repository specified if skip-push flag is set [build]
C:/actions-runner/_work/devpod/devpod/e2e/tests/build/build.go:80

  [FAILED] Unexpected error:
      <*errors.errorString | 0xc0006fa260>: 
      devpod provider add failed: exit status 1
      {
          s: "devpod provider add failed: exit status 1",
      }
  occurred
  In [It] at: C:/actions-runner/_work/devpod/devpod/e2e/tests/build/build.go:90 @ 12/10/24 08:58:15.414

@lentzi90 lentzi90 changed the title Add positional arguments to CLI usage Add positional arguments to CLI usage string Dec 10, 2024
@pascalbreuninger
Copy link
Member

@lentzi90 We're having troubles with our self hosted windows runner... You can safely ignore that for now but I think you'll need to rebase your changes

Positional arguments like the machine name or provider name are
undocumented in the CLI. This commit adds them to the "Use" string so
that they show up with the --help flag.
@pascalbreuninger pascalbreuninger merged commit 87c59f2 into loft-sh:main Dec 11, 2024
17 of 23 checks passed
@lentzi90 lentzi90 deleted the cli-argument-docs branch December 11, 2024 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants