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

--template is required to use krane run #668

Merged
merged 1 commit into from
Jan 20, 2020
Merged

Conversation

cjoudrey
Copy link
Contributor

When reading the usage of krane run in the README.md, I noticed the --template option was documented as being optional.

This doesn't match the current behaviour of krane run:

$ krane run
No value provided for required options '--template'

After chatting with @dturn, it sounds like this was a typo in the README.md, hence this PR. 😄

@cjoudrey cjoudrey requested a review from dturn January 17, 2020 22:56
@@ -503,7 +503,7 @@ Based on this specification `krane run` will create a new pod with the entrypoin

*Options:*

* `--template=TEMPLATE`: Specifies the name of the PodTemplate to use (default is `task-runner-template` if this option is not set).
* `--template=TEMPLATE`: Specifies the name of the PodTemplate to use.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wasn't sure what the convention was to mention the option is required.

I was going to put:

Suggested change
* `--template=TEMPLATE`: Specifies the name of the PodTemplate to use.
* `--template=TEMPLATE` (required): Specifies the name of the PodTemplate to use.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not a convention we're currently using.

@cjoudrey cjoudrey merged commit 905caba into master Jan 20, 2020
@cjoudrey cjoudrey deleted the fix-readme-run-template branch January 20, 2020 15:06
@dturn dturn temporarily deployed to rubygems January 22, 2020 19:12 Inactive
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