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

fix(CLI): add tool name to Retina CLI help message #891

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

k-nzw
Copy link

@k-nzw k-nzw commented Oct 25, 2024

Description

This PR fixes a bug where the tool name is missing in the help message of Retina CLI.
As a side effect, the kubectl-retina completion command will now generate a completion script that works correctly.

Related Issue

If this pull request is related to any issue, please mention it here. Additionally, make sure that the issue is assigned to you before submitting this pull request.
#973

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Screenshots (if applicable) or Testing Completed

Please add any relevant screenshots or GIFs to showcase the changes made.

Additional Notes

before:

$ kubectl-retina
Usage:
   [command]

after:

$ kubectl-retina
A kubectl plugin for Retina
Retina is an eBPF distributed networking observability tool for Kubernetes.

Usage:
  kubectl-retina [command]

Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

@k-nzw k-nzw requested a review from a team as a code owner October 25, 2024 10:34
@k-nzw k-nzw changed the title fix: add usage message to cli fix: add tool name to cli help message Oct 28, 2024
cli/cmd/root.go Show resolved Hide resolved
@k-nzw k-nzw changed the title fix: add tool name to cli help message fix(CLI): add tool name to Retina CLI help message Nov 5, 2024
@k-nzw k-nzw marked this pull request as draft November 8, 2024 06:57
@k-nzw k-nzw marked this pull request as ready for review November 8, 2024 06:59
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