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.

Sign up for GitHub

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

Jump to bottom

Add sub command for completion and documentation generation #484

Merged
merged 1 commit into from
Jun 11, 2019
Merged

Add sub command for completion and documentation generation #484

merged 1 commit into from
Jun 11, 2019

Conversation

eqrx
Copy link
Contributor

@eqrx eqrx commented Jun 7, 2019

What this PR does / why we need it:
See #480

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #480

Special notes for your reviewer:
Needed to upgrade cobra dependency to 0.0.4 because it has a helper method that simplifies argument parsing. Should the command be added to to documentation?

Documentation:
None

Release note:

`completion` and `doc` added for shell complation and documentation generation

@eqrx eqrx requested a review from xmudrii June 7, 2019 14:59
@kubermatic-bot kubermatic-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. dco-signoff: no Denotes that at least one commit in the pull request doesn't have a valid DCO signoff message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 7, 2019
@eqrx eqrx force-pushed the completionsdocscommands branch from ced6434 to 335311d Compare June 7, 2019 15:06
@kubermatic-bot kubermatic-bot added dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. and removed dco-signoff: no Denotes that at least one commit in the pull request doesn't have a valid DCO signoff message. labels Jun 7, 2019
kron4eg
kron4eg reviewed Jun 7, 2019
View reviewed changes
pkg/cmd/packaging.go Outdated
Use: "doc <man|md|rest|yaml>",
Short: "Generates documentation",
Long: "Generation can be generated as Man Pages, Markdown, ReStructured Text Docs or Yaml",
Example: "kubeone completion bash",
Copy link
Member

Choose a reason for hiding this comment

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

should be kubeone doc md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

also changed it to document, seems more consistent for me for it to be a verb

@eqrx eqrx self-assigned this Jun 7, 2019
@eqrx eqrx force-pushed the completionsdocscommands branch from 335311d to b90de5b Compare June 7, 2019 20:23
xmudrii
xmudrii requested changes Jun 8, 2019
View reviewed changes
Copy link
Member

@xmudrii xmudrii left a comment

Choose a reason for hiding this comment

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

Looks great! 💯 I found some typos, but otherwise lgtm.

pkg/cmd/packaging.go Outdated
Short: "Generates completion scripts for bash and zsh",
Long: `To load completion run into your current shell run

. <(kubeone bashCompletion <shell>)
Copy link
Member

Choose a reason for hiding this comment

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

There's a typo in the description:

Suggested change
. <(kubeone bashCompletion <shell>)
. <(kubeone completion <shell>)

pkg/cmd/packaging.go Outdated Show resolved Hide resolved
pkg/cmd/packaging.go Outdated Show resolved Hide resolved
@xmudrii
Copy link
Member

xmudrii commented Jun 8, 2019

@eqrx Regarding the documentation question, a quick document explaining how to activate the completion and generate documentation would be nice. Maybe even just putting quick description in the README would work as well.

Add sub command for completion and documentation generation
e2ea7c1 
Signed-off-by: Alexander Sowitzki <alexander@loodse.com>
@eqrx
Copy link
Contributor Author

eqrx commented Jun 10, 2019

/retest

@eqrx eqrx requested a review from xmudrii June 11, 2019 08:11
xmudrii
xmudrii approved these changes Jun 11, 2019
View reviewed changes
Copy link
Member

@xmudrii xmudrii left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@kubermatic-bot kubermatic-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 11, 2019
@kubermatic-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4a2837ed652a24af17095738d4322a3b7dce88f0

@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: xmudrii

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubermatic-bot kubermatic-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 11, 2019
@kubermatic-bot kubermatic-bot merged commit 91fa3c9 into master Jun 11, 2019
@kubermatic-bot kubermatic-bot deleted the completionsdocscommands branch June 11, 2019 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kron4eg kron4eg kron4eg left review comments

@xmudrii xmudrii xmudrii approved these changes

Assignees

@xmudrii xmudrii

@eqrx eqrx

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add additional sub commands for packagers
4 participants
@eqrx @xmudrii @kubermatic-bot @kron4eg