Skip to content

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

Merged
merged 1 commit into from
Jun 27, 2025

Conversation

carlwgeorge
Copy link
Contributor

@carlwgeorge carlwgeorge commented Jun 27, 2025

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:

  • Update Makefile to generate and install zsh completions in $(DESTDIR)${SHAREDIR}/zsh/site-functions
  • Adjust pyproject.toml to include zsh completions under share/zsh/site-functions
  • Revise RPM spec to use %{zsh_completions_dir} for zsh completion installation

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]>
Copy link
Contributor

sourcery-ai bot commented Jun 27, 2025

Reviewer's Guide

Switches 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 update

flowchart 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
Loading

File-Level Changes

Change Details Files
Updated Makefile to install zsh completions under site‐functions instead of vendor‐completions.
  • Changed install-completions target to create and use zsh/site-functions directory
  • Redirected generated _ramalama file into completions/zsh/site-functions in completions rule
Makefile
Adjusted Python package manifest to map zsh completions into site‐functions.
  • Replaced share/zsh/vendor-completions entry with share/zsh/site-functions in pyproject.toml
pyproject.toml
Modified RPM spec to install zsh completions via the Fedora zsh_completions_dir macro.
  • Swapped %{_datadir}/zsh/vendor-completions path for %{zsh_completions_dir} in spec
rpm/python-ramalama.spec

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 to site-functions. This affects how the completion files are generated, installed, and packaged.
  • Makefile Adjustments: The Makefile has been modified in both the completions and install-completions targets to use the new site-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 the rpm/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

  1. 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.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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 under site-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`.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

@ericcurtin ericcurtin merged commit a019b91 into containers:main Jun 27, 2025
20 of 21 checks passed
@carlwgeorge carlwgeorge deleted the zsh-completions branch June 27, 2025 15:17
@ericcurtin
Copy link
Member

Thanks @carlwgeorge

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