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

Print help when no args are passed #1674

Merged
merged 1 commit into from
Jul 26, 2021
Merged

Conversation

carolynvs
Copy link
Member

What does this change

We should print help text in the following scenarios:

  • porter
  • porter help
  • porter --help

The reason why this isn't happening by default is because our root command implements Run. This allows us to print the version for either:

  • porter --version
  • porter version

There are tests now for all of the behaviors above to catch regressions.

What issue does it fix

Closes #1673

Notes for the reviewer

Put any questions or notes for the reviewer here.

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

We should print help text in the following scenarios:

* porter
* porter help
* porter --help

The reason why this isn't happening by default is because our root
command implements Run. This allows us to print the version for either
* porter --version
* porter version

There are tests now for all of the behaviors above to catch regressions.

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
@carolynvs carolynvs marked this pull request as ready for review July 23, 2021 12:17
@carolynvs carolynvs merged commit ef46664 into getporter:main Jul 26, 2021
@carolynvs carolynvs deleted the help branch July 26, 2021 15:15
@carolynvs carolynvs mentioned this pull request Aug 11, 2021
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.

When executed without sub commands or arguments porter shall return help message
2 participants