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

Incorrect helptext for porter installation runs list #2514

Closed
carolynvs opened this issue Jan 9, 2023 · 0 comments · Fixed by #2794
Closed

Incorrect helptext for porter installation runs list #2514

carolynvs opened this issue Jan 9, 2023 · 0 comments · Fixed by #2794

Comments

@carolynvs
Copy link
Member

Describe the bug

The helptext for the porter installation runs list command is incorrect.

To Reproduce

  1. porter installation runs list says that --name is a flag in the example text porter installations runs list --name myapp --namespace dev
$ porter installation runs list --help
List runs of an Installation

Usage:
  porter installations runs list [flags]

Examples:
  porter installation runs list [NAME] [--namespace NAMESPACE] [--output FORMAT]

  porter installations runs list --name myapp --namespace dev



Flags:
  -h, --help               help for list
  -n, --namespace string   Namespace in which the installation is defined. Defaults to the global namespace.
  -o, --output string      Specify an output format.  Allowed values: plaintext, json, yaml (default "plaintext")

Global Flags:
      --experimental strings   Comma separated list of experimental features to enable. See https://getporter.org/configuration/#experimental-feature-flags for available feature flags.
      --verbosity string       Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info")
  1. But using it fails...
$ porter installation runs list --name examples/otel-jaeger --namespace quickstart
unknown flag: --name

Expected behavior

The example text should reflect the current behavior of the command. Let's update the usage to reflect the full command porter installation runs list [NAME] [--namespace NAMESPACE] [--output FORMAT] and the example should be updated to follow the current behavior (i.e. do not use --name, specify the name as the first positional argument).

porter installation runs list myapp --namespace dev

Version

1.0.3

@carolynvs carolynvs added the bug Oops, sorry! label Jan 9, 2023
@carolynvs carolynvs removed the bug Oops, sorry! label Jan 9, 2023
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 a pull request may close this issue.

1 participant