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

Update help text to perform as expected #2794

Merged
merged 3 commits into from
Jun 27, 2023

Conversation

troy0820
Copy link
Member

@troy0820 troy0820 commented Jun 23, 2023

What does this change

Changes the help text to properly describe how to use the porter installation run list

image

List runs of an Installation

Usage:
  porter installations runs list [flags]

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

  porter installations runs list 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")

What issue does it fix

Closes #2514

Notes for the reviewer

Put any questions or notes for the reviewer here.

Checklist

  • Did you write tests?
    • No, this just updates the help text
  • Did you write documentation?
    • No, there is no documentation update necessary for this change.
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@troy0820 troy0820 changed the title update help text to perform as expected Update help text to perform as expected Jun 23, 2023
Copy link
Contributor

@bdegeeter bdegeeter left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Member

@schristoff schristoff left a comment

Choose a reason for hiding this comment

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

/azp run porter-integration

@troy0820
Copy link
Member Author

/azp run porter-integration

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 2794 in repo getporter/porter

@schristoff schristoff merged commit 8c6edf7 into getporter:main Jun 27, 2023
7 of 12 checks passed
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.

Incorrect helptext for porter installation runs list
3 participants