Add bash/zsh completion command #1437

bharathi-tenneti · 2020-03-19T14:01:56Z

Description:
Add completion command to enable Auto bash/zsh completion.
Motivation:
To have kubebuilder cli auto completion enabled.
Closes: #1346

k8s-ci-robot · 2020-03-19T14:02:04Z

Welcome @bharathi-tenneti!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2020-03-19T14:02:04Z

Hi @bharathi-tenneti. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

camilamacedo86 · 2020-03-19T14:16:45Z

go.mod

+	k8s.io/api v0.17.4
+	k8s.io/apimachinery v0.17.4
+	k8s.io/client-go v11.0.0+incompatible
+	sigs.k8s.io/controller-runtime v0.5.1


Upgrade the API's are not part of the scope of his PR.
Could you please revert?

camilamacedo86 · 2020-03-19T14:17:24Z

testdata/project-v2-addon/config/default/manager_auth_proxy_patch.yaml

@@ -10,7 +10,7 @@ spec:
    spec:
      containers:
      - name: kube-rbac-proxy
-        image: gcr.io/kubebuilder/kube-rbac-proxy:v0.4.1
+        image: gcr.io/kubebuilder/kube-rbac-proxy:v0.5.0


Could you please rebase your branch with the master?

cmd/main.go

camilamacedo86 · 2020-03-20T01:32:29Z

cmd/completion.go

+func newCompletionCmd() *cobra.Command {
+	completionCmd := &cobra.Command{
+		Use:   "completion",
+		Short: "Generators for shell completions",


WDYT about we add the Lond desc and the Examples? See an example of this impl:

kubebuilder/cmd/init.go

Line 51 in 232c524

Long: `Initialize a new project including vendor/ directory and Go package directories.

?

Also, I think that the long desc could describe its purpose as to how to use it.

cmd/completion.go

camilamacedo86 · 2020-03-21T11:36:18Z

cmd/completion.go

+func newCompletionCmd() *cobra.Command {
+	completionCmd := &cobra.Command{
+		Use:   "completion",
+		Short: "Generators for shell completions",


Suggested change

Short: "Generators for shell completions",

Short: "Generators for shell completions",

Long:`Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubebuilder commands. This can be done by sourcing it from the .bash_profile.

Detailed instructions on how to do this are available here:

<add a link for the kubebuilder docs with the further information, note that it should similar to https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion>`

camilamacedo86 · 2020-03-21T11:48:02Z

cmd/completion.go

+		Short: "Generate bash completions",
+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenBashCompletion(os.Stdout)
+		},


Also, we need to add the Examples:

Example: `# Run the command to generate the bash completion and create the file $kubebuilder completion bash >> ~/.kubebuilder TODO: Add all the steps required to set up it. "

$ kubebuilder completion bash >> ~/.bashrc

Suggested change

},

},

Example: `To load completion run:

$ . <(kubebuilder completion bash)

To configure your bash shell to load completions for each session add to your bashrc:

$ echo -e "\n. <(kubebuilder completion bash)" >> ~/.bashrc

`,

estroz · 2020-03-21T19:29:33Z

/ok-to-test

docs/book/src/quick-start.md

camilamacedo86 · 2020-03-26T11:22:31Z

docs/book/src/reference/completion.md

@@ -0,0 +1,53 @@
+# Enabling shell auto completion


I am not able to check it in the Reference category in the preview. Could you please check?

camilamacedo86 · 2020-03-26T11:24:30Z

docs/book/src/reference/completion.md

+
+`echo BASH_VERSION`
+
+#### To upgrade, you may use homebrew:


If these are the steps then, I do not think that we should use ### since it is for section titles.

See an example of the layout applied in another place: https://deploy-preview-1437--kubebuilder.netlify.com/reference/kind.html#cheetsheet

camilamacedo86 · 2020-03-26T11:27:21Z

cmd/completion.go

+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenZshCompletion(os.Stdout)
+		},
+	}


Wdyt about add the examples here in the commands?

camilamacedo86 · 2020-03-30T15:06:14Z

docs/book/src/quick-start.md

+</aside>
+
+<aside class="note">
+<h1>Enable shell auto completion</h1>


Suggested change

<h1>Enable shell auto completion</h1>

<h1>Enabling shell autocompletion</h1>

To keep the same standard applied in the docs.

camilamacedo86 · 2020-03-30T15:09:39Z

docs/book/src/quick-start.md

+<aside class="note">
+<h1>Enable shell auto completion</h1>
+
+Optional: To enable kubebuilder shell auto completion, please refer to [this](./reference/completion.md) document.


Suggested change

Optional: To enable kubebuilder shell auto completion, please refer to [this](./reference/completion.md) document.

Kubebuilder provides autocompletion support for Bash and Zsh via the command `kubebuilder completion <bash|zsh>`, which can save you a lot of typing. For further information see the [completion](./reference/completion.md) document.

camilamacedo86 · 2020-03-30T15:15:35Z

docs/book/src/reference/completion.md

@@ -0,0 +1,29 @@
+# Enable shell auto completion
+


Suggested change

The Kubebuilder completion script for Bash can be generated with the command `kubebuilder completion bash` as the Kubebuilder completion script for Zsh can be generated with the command `kubebuilder completion zsh`.

Note that sourcing the completion script in your shell enables Kubebuilder autocompletion.

camilamacedo86 · 2020-03-30T15:15:44Z

docs/book/src/reference/completion.md

@@ -0,0 +1,29 @@
+# Enable shell auto completion


Suggested change

# Enable shell auto completion

# Enabling shell autocompletion

Following the docs standard/format for titles

camilamacedo86 · 2020-03-30T15:19:28Z

docs/book/src/reference/completion.md

@@ -0,0 +1,29 @@
+# Enable shell auto completion
+
+## Prerequisites


Suggested change

## Prerequisites

</aside>

<aside class="note">

<h1>Prerequisites for Bash</h1>

The completion Bash script depends on [bash-completion](https://github.com/scop/bash-completion), which means that you have to install this software first (you can test if you have bash-completion already installed. Also, ensure that your Bash version is 4.1+.

</aside>

Need to talk about zsh too

@estroz Is the bash-completion a prerequisite for the zsh?

camilamacedo86 · 2020-03-30T15:19:53Z

docs/book/src/reference/completion.md

+## Prerequisites
+
+- Bash 4.1+/zsh 
+- bash-completion/zsh-completions v2


Suggested change

- bash-completion/zsh-completions v2

Info added in the above note.

camilamacedo86 · 2020-03-30T15:20:04Z

docs/book/src/reference/completion.md

+
+## Prerequisites
+
+- Bash 4.1+/zsh 


Suggested change

- Bash 4.1+/zsh

Info added in the above note.

camilamacedo86 · 2020-03-30T15:28:07Z

docs/book/src/reference/completion.md

+
+- Once installed, go ahead and add the path `/usr/local/bin/bash` in the  `/etc/shells`.
+
+    `sudo echo “/usr/local/bin/bash” > /etc/shells`


HI @bharathi-tenneti and @estroz,

Why the sudo here is required?

Also, note that the bash requirements is just important for the bash one and not zsh. So, we cannot have the same pre-requirements for both. See my suggestion above

Are these steps valid for any OS? So how can we add generic steps if they are not?. I think we could do similar the structure of the kubtecl docs here. See: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion

Same concern as below #1437 (comment)

camilamacedo86 · 2020-03-30T15:31:26Z

docs/book/src/reference/completion.md

+
+- Bash 4.1+/zsh 
+- bash-completion/zsh-completions v2
+


IMO it should be :

Bash on Linux

//Add the steps

Bash on Mac

// Add the steps

Zsh

// Add the steps

We should avoid discussing prereq installation steps on different systems, since "linux" has various distros (read: package managers). Perhaps a link to each package would help.

Listing the prerequisite packages and versions delegates installation (which is relatively simple in this case) to the user. By doing so we also avoid doc drift in case prereqs change.

@estroz @camilamacedo86
As I could test out on macOS, I can list out steps for the same.
Any idea on how do folks go about for other distributions?
Can I leave a TODO note for others such as ""linux", and "zsh"?

The problem here is that I am not sure if the same steps will work for both (Linux or Mac).

Regards the pre-requirement for bash it is the same for kubectl and for both (Linux or Mac) its docs is addressing the same repo. There has the info over how to install in each SO.

So, IMO we can move forward with:

Enabling shell autocompletion

(introduction)

Bash

(pre-requirement note)

(steps)

Then, we can improve it in the future.

@camilamacedo86
So, no changes for now. Did I understand correctly?

mengqiy · 2020-03-30T23:57:03Z

/approve
/hold
@camilamacedo86 @estroz Please feel free to unhold it after comments are addressed.

camilamacedo86 · 2020-03-31T12:56:09Z

@bharathi-tenneti,

@mengqiy is ok to merge it after address the comments made an fix the docs.
Am I right @mengqiy? Also, please let if I understood something here.

camilamacedo86

@bharathi-tenneti,

You can use the preview to check the changes. Just few nits are missing here for we are able to move forward. See: https://deploy-preview-1437--kubebuilder.netlify.com/reference/completion.html

Fix the link:

Put the NOTE Follow a similar protocol for zsh completion. in an not follow its standard.
See:

camilamacedo86 · 2020-03-31T20:08:37Z

docs/book/src/reference/completion.md

+```
+- Restart terminal for the changes to be reflected.
+
+Follow a similar protocol for `zsh` completion.


Suggested change

Follow a similar protocol for `zsh` completion.

</aside>

<aside class="note">

<h1>Zsh</h1>

Follow a similar protocol for `zsh` completion.

</aside>

bharathi-tenneti · 2020-03-31T20:26:14Z

/retest

camilamacedo86

I think that a few details still with a hall to improvements, however, we can do it in a follow-up pr and it shows to attend the requirements and is OK for others as well.

So,
/lgtm
/approve

k8s-ci-robot · 2020-04-01T14:31:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bharathi-tenneti, camilamacedo86, mengqiy

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:

~~OWNERS~~ [camilamacedo86,mengqiy]

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

camilamacedo86 · 2020-04-01T14:32:06Z

/hold cancel

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 19, 2020

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 19, 2020

k8s-ci-robot requested review from camilamacedo86 and estroz March 19, 2020 14:02

camilamacedo86 reviewed Mar 19, 2020

View reviewed changes

bharathi-tenneti force-pushed the bashcompletion#1346 branch from 148f794 to 232c524 Compare March 19, 2020 16:23

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 19, 2020

camilamacedo86 reviewed Mar 20, 2020

View reviewed changes

cmd/main.go Show resolved Hide resolved

camilamacedo86 reviewed Mar 20, 2020

View reviewed changes

cmd/completion.go Show resolved Hide resolved

camilamacedo86 reviewed Mar 21, 2020

View reviewed changes

bharathi-tenneti changed the title ~~Add bash/zsh completion command~~ <WIP> Add bash/zsh completion command Mar 25, 2020

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 25, 2020

bharathi-tenneti requested a review from camilamacedo86 March 25, 2020 17:17

camilamacedo86 reviewed Mar 26, 2020

View reviewed changes

docs/book/src/quick-start.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 26, 2020

View reviewed changes

bharathi-tenneti requested a review from camilamacedo86 March 26, 2020 21:07

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 27, 2020

camilamacedo86 reviewed Mar 30, 2020

View reviewed changes

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 30, 2020

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 31, 2020

bharathi-tenneti requested a review from camilamacedo86 March 31, 2020 14:11

bharathi-tenneti force-pushed the bashcompletion#1346 branch from ce1d5ba to dba820e Compare March 31, 2020 20:04

camilamacedo86 reviewed Mar 31, 2020

View reviewed changes

Add bash/zsh completion command.

156c9b3

bharathi-tenneti force-pushed the bashcompletion#1346 branch from ec5adb8 to 156c9b3 Compare April 1, 2020 14:19

camilamacedo86 approved these changes Apr 1, 2020

View reviewed changes

k8s-ci-robot assigned camilamacedo86 Apr 1, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 1, 2020

k8s-ci-robot merged commit 76050aa into kubernetes-sigs:master Apr 1, 2020

camilamacedo86 mentioned this pull request Feb 18, 2021

New Release - proposing 3.0.0 stable #2029

Closed

-		Short: "Generators for shell completions",
+		Short: "Generators for shell completions",
+		Long:`Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubebuilder commands.  This can be done by sourcing it from the .bash_profile.
+ Detailed instructions on how to do this are available here:
+<add a link for the kubebuilder docs with the further information, note that it should similar to https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion>`

-		},
+		},
+		 Example: `To load completion run:
+  $ . <(kubebuilder completion bash)
+To configure your bash shell to load completions for each session add to your bashrc:
+  $ echo -e "\n. <(kubebuilder completion bash)" >> ~/.bashrc
+`,

	<h1>Enable shell auto completion</h1>
	<h1>Enabling shell autocompletion</h1>

	Optional: To enable kubebuilder shell auto completion, please refer to [this](./reference/completion.md) document.
	Kubebuilder provides autocompletion support for Bash and Zsh via the command `kubebuilder completion <bash\|zsh>`, which can save you a lot of typing. For further information see the [completion](./reference/completion.md) document.


	The Kubebuilder completion script for Bash can be generated with the command `kubebuilder completion bash` as the Kubebuilder completion script for Zsh can be generated with the command `kubebuilder completion zsh`.

	Note that sourcing the completion script in your shell enables Kubebuilder autocompletion.

	# Enable shell auto completion
	# Enabling shell autocompletion

		@@ -0,0 +1,29 @@
		# Enable shell auto completion

		## Prerequisites


		- Once installed, go ahead and add the path `/usr/local/bin/bash` in the `/etc/shells`.

		`sudo echo “/usr/local/bin/bash” > /etc/shells`

Add bash/zsh completion command #1437

Add bash/zsh completion command #1437

Conversation

bharathi-tenneti commented Mar 19, 2020

k8s-ci-robot commented Mar 19, 2020

k8s-ci-robot commented Mar 19, 2020

camilamacedo86 Mar 19, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Mar 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estroz commented Mar 21, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Mar 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Mar 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bash on Linux

Bash on Mac

Zsh

estroz Mar 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Mar 31, 2020 • edited Loading

Choose a reason for hiding this comment

Enabling shell autocompletion

Bash

Choose a reason for hiding this comment

mengqiy commented Mar 30, 2020

camilamacedo86 commented Mar 31, 2020

camilamacedo86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharathi-tenneti commented Mar 31, 2020

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 1, 2020

camilamacedo86 commented Apr 1, 2020

camilamacedo86 Mar 19, 2020 •

edited

Loading

camilamacedo86 Mar 20, 2020 •

edited

Loading

camilamacedo86 Mar 30, 2020 •

edited

Loading

camilamacedo86 Mar 30, 2020 •

edited

Loading

estroz Mar 30, 2020 •

edited

Loading

camilamacedo86 Mar 31, 2020 •

edited

Loading