-
Notifications
You must be signed in to change notification settings - Fork 235
Use standard zsh completion directory #1619
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
Conversation
We're currently using /usr/share/zsh/vendor-completions for zsh completions. However, the RPM macro %{zsh_completions_dir} (which is required by the Fedora packaging guidelines) is defined as /usr/share/zsh/site-functions, so let's switch to that. https://docs.fedoraproject.org/en-US/packaging-guidelines/ShellCompletions/ Signed-off-by: Carl George <[email protected]>
Reviewer's GuideSwitches zsh completions from the nonstandard vendor‐completions directory to the standard site‐functions path in the Makefile, pyproject.toml, and RPM spec to comply with the Fedora %{zsh_completions_dir} macro. Flow diagram for zsh completions installation process updateflowchart TD
subgraph Old
O1[mkdir -p completions/zsh/vendor-completions]
O2[register-python-argcomplete --shell zsh ramalama > completions/zsh/vendor-completions/_ramalama]
O3[install to /usr/share/zsh/vendor-completions/_ramalama]
end
subgraph New
N1[mkdir -p completions/zsh/site-functions]
N2[register-python-argcomplete --shell zsh ramalama > completions/zsh/site-functions/_ramalama]
N3[install to /usr/share/zsh/site-functions/_ramalama]
end
O1 -. replaced by .-> N1
O2 -. replaced by .-> N2
O3 -. replaced by .-> N3
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @carlwgeorge, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request standardizes the installation location for Zsh shell completion files for the ramalama
tool. The changes align the project's build and packaging processes with Fedora's packaging guidelines by switching the Zsh completion directory from vendor-completions
to site-functions
, ensuring proper system integration and adherence to best practices.
Highlights
- Zsh Completion Path Update: The primary change involves updating all references to the Zsh completion directory from
vendor-completions
tosite-functions
. This affects how the completion files are generated, installed, and packaged. - Makefile Adjustments: The
Makefile
has been modified in both thecompletions
andinstall-completions
targets to use the newsite-functions
directory for creating and installing Zsh completion files. - Packaging Metadata Alignment: The
pyproject.toml
file has been updated to reflect the new installation path for Zsh completions, and therpm/python-ramalama.spec
file now utilizes the standard Fedora macro%{zsh_completions_dir}
for Zsh completion files, ensuring compliance with Fedora packaging guidelines.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @carlwgeorge - I've reviewed your changes - here's some feedback:
- Ensure any CI/CD steps or external scripts referencing the old zsh vendor-completions path are updated to use
zsh/site-functions
. - Consider adding a symlink from the old
vendor-completions
directory for backward compatibility or documenting the migration path. - Verify that the generated
_ramalama
completion file contains the correct#compdef ramalama
directive to work properly undersite-functions
.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Ensure any CI/CD steps or external scripts referencing the old zsh vendor-completions path are updated to use `zsh/site-functions`.
- Consider adding a symlink from the old `vendor-completions` directory for backward compatibility or documenting the migration path.
- Verify that the generated `_ramalama` completion file contains the correct `#compdef ramalama` directive to work properly under `site-functions`.
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively addresses the stated objective of aligning zsh completion paths with Fedora packaging guidelines. The changes in Makefile
, pyproject.toml
, and rpm/python-ramalama.spec
are consistent and correctly implement the switch to the standard site-functions
directory and the use of the %{zsh_completions_dir}
RPM macro. The changes are straightforward and do not introduce any new medium
, high
, or critical
issues related to correctness, efficiency, maintainability, or security.
Thanks @carlwgeorge |
We're currently using
/usr/share/zsh/vendor-completions
for zsh completions. However, the RPM macro%{zsh_completions_dir}
(which is required by the Fedora packaging guidelines) is defined as/usr/share/zsh/site-functions
, so let's switch to that.https://docs.fedoraproject.org/en-US/packaging-guidelines/ShellCompletions/
Summary by Sourcery
Switch zsh completion path to the standard site-functions directory to comply with Fedora packaging guidelines.
Enhancements: