Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix zsh autocompletion #4903

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
Closed
askervin wants to merge 1 commit into from
Closed

Fix zsh autocompletion #4903

askervin wants to merge 1 commit into from

Conversation

@askervin
Copy link
Contributor

@askervin askervin commented May 17, 2021

  • Fix unmatched ' issue on commands.
  • Split commands and options on separate lines to make
    them easier to review and less prone to merge conflicts.

Signed-off-by: Antti Kervinen [email protected]

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

  • This PR fixes crio command autocompletion on zsh.
  • This PR makes completion/zsh/_crio less prone to merge conflicts. Currently all commits that add command line options will conflict due to this file. This helps reviewing zsh completion changes, too.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

Does this PR introduce a user-facing change?

@askervin askervin requested a review from mrunalp as a code owner May 17, 2021 07:23
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 17, 2021

@askervin: Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

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.

@askervin askervin requested a review from runcom as a code owner May 17, 2021 07:23
@openshift-ci openshift-ci bot added dco-signoff: yes Indicates the PR's author has DCO signed all their commits. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels May 17, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 17, 2021

Hi @askervin. Thanks for your PR.

I'm waiting for a cri-o 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.

Details

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.

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 17, 2021
@openshift-ci openshift-ci bot requested review from sboeuf and umohnani8 May 17, 2021 07:23
@haircommander
Copy link
Member

haircommander commented May 17, 2021

thanks for the PR @askervin !

our zsh completions are autogenerated by a go template: https://github.com/cri-o/cri-o/blob/master/internal/criocli/completion.go#L75
Are you able to the template to output in a more suitable way?

@haircommander
Copy link
Member

haircommander commented May 17, 2021

/ok-to-test

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 17, 2021
@askervin
Copy link
Contributor Author

askervin commented May 17, 2021

our zsh completions are autogenerated by a go template: https://github.com/cri-o/cri-o/blob/master/internal/criocli/completion.go#L75

Oh, that's great! Thanks for pointing this out, @haircommander. :)

Are you able to the template to output in a more suitable way?

Sure thing. I hope this is fine. Escaping single quotes inside single quotes looks a bit complicated in shells, but it works...

@fidencio
Copy link
Contributor

fidencio commented May 17, 2021

/test kata-containers

@haircommander
Copy link
Member

haircommander commented May 17, 2021

hm are you running make completions-generation to make sure the changes are reflected in the files? The completions job still shows it hasn't quite worked:
https://github.com/cri-o/cri-o/pull/4903/checks?check_run_id=2601859524
you can run make completions-validation to verify you'll pass the completions job here

@askervin
Copy link
Contributor Author

askervin commented May 18, 2021

hm are you running make completions-generation

Ah, I was missing that. Generated changes amended and force-pushed.

Couldn't run make completions-validation, there doesn't seem to be such target in the Makefile.

@openshift-ci openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 18, 2021
@wgahnagl
Copy link
Contributor

wgahnagl commented Aug 10, 2021

@askervin hello! Could you give this a rebase?

@askervin askervin force-pushed the 5Ci_fix_zsh branch 2 times, most recently from d53db87 to 9c481c0 Compare August 11, 2021 06:36
@openshift-ci openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 11, 2021
@askervin
Copy link
Contributor Author

askervin commented Aug 11, 2021

@wgahnagl, Thanks for reminder! Rebased and retested on top of the master branch.

@codecov
Copy link

codecov bot commented Aug 11, 2021 •
edited
Loading

Codecov Report

Merging #4903 (433ac83) into main (35d1be8) will increase coverage by 0.49%.
The diff coverage is 0.00%.

❗ Current head 433ac83 differs from pull request most recent head 03805a6. Consider uploading reports for the commit 03805a6 to get more accurate results

@@            Coverage Diff             @@
##             main    #4903      +/-   ##
==========================================
+ Coverage   43.76%   44.26%   +0.49%     
==========================================
  Files         118      112       -6     
  Lines       11721    11565     -156     
==========================================
- Hits         5130     5119      -11     
+ Misses       6104     5959     -145     
  Partials      487      487

@openshift-ci openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 19, 2021
@askervin
Fix zsh completion
03805a6 
- Fix unmatched ' issue in commands.
- Split commands and options on separate lines to make
  them easier to review and less prone to merge conflicts.
- Keep multi-line usages on single line, this removes
  characters "\n" from zsh completion output.

Signed-off-by: Antti Kervinen <[email protected]>
@openshift-ci openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 16, 2021
@askervin
Copy link
Contributor Author

askervin commented Sep 16, 2021

@wgahnagl , @haircommander , I think this PR would be good to go. Fixes an error and results in fewer conflicts in completions/_crio when new command line parameters are added.

@haircommander
Copy link
Member

haircommander commented Sep 16, 2021

/retest

(shfmt test failure is unrelated)
/approve

@QiWang19 @wgahnagl @fgiudici PTAL for final review

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 16, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: askervin, haircommander

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

The pull request process is described here

Details 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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 16, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 16, 2021

@askervin: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Rerun command
ci/openshift-jenkins/e2e_crun_cgroupv2 03805a6 link /test e2e_cgroupv2
ci/openshift-jenkins/integration_crun_cgroupv2 03805a6 link /test integration_cgroupv2
ci/openshift-jenkins/e2e_rhel 03805a6 link /test e2e_rhel

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

@openshift-ci openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 19, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 19, 2021

@askervin: PR needs rebase.

Details

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.

@askervin
Copy link
Contributor Author

askervin commented Jun 6, 2022

Already fixed by #5586 .

@askervin askervin closed this Jun 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mrunalp mrunalp Awaiting requested review from mrunalp mrunalp is a code owner

@runcom runcom Awaiting requested review from runcom

@sboeuf sboeuf Awaiting requested review from sboeuf

@umohnani8 umohnani8 Awaiting requested review from umohnani8

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@askervin @haircommander @fidencio @wgahnagl