README.md: add instructions to switch taps#98
Conversation
Summary of ChangesHello, 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 enhances the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to guide users in switching from the deprecated Homebrew tap slp/krunkit to the new slp/krun tap. The changes are clear and provide necessary commands for the transition. I've added a couple of suggestions to improve the wording and formatting for better clarity and consistency in the documentation.
README.md
Outdated
| ## Installation | ||
|
|
||
| > [!IMPORTANT] | ||
| > If you've ever installed krunkit from the old tap `slp/krunkit`, to upgrade to the latest version you'll need to follow the "Removing the old Homebrew tap" instructions first, and then install from scratch. |
There was a problem hiding this comment.
For consistency and readability, it's good practice to wrap package names and tap names in backticks, as you've done elsewhere in the file. Please wrap krunkit and slp/krunkit in backticks.
| > If you've ever installed krunkit from the old tap `slp/krunkit`, to upgrade to the latest version you'll need to follow the "Removing the old Homebrew tap" instructions first, and then install from scratch. | |
| > If you've ever installed `krunkit` from the old tap `slp/krunkit`, to upgrade to the latest version you'll need to follow the "Removing the old Homebrew tap" instructions first, and then install from scratch. |
|
Other than the comment above, LGTM |
We have deprecated the old tap, so extend the instructions to explain how to switch from it to the new one. Signed-off-by: Sergio Lopez <slp@redhat.com>
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request updates the README.md file to provide instructions for users to switch from the old, deprecated Homebrew tap to the new one. The changes are clear and address the goal described. I have one suggestion to simplify the provided shell commands for a more user-friendly and robust process, leveraging Homebrew's own interactive guidance.
| The `slp/krunkit` tap is now deprecated. If you've ever installed `krunkit` from it, you'll need to remove all packages from that tap and then the tap itself: | ||
|
|
||
| ``` | ||
| $ brew list --full-name | grep "^slp/krunkit/" | xargs brew uninstall | ||
| $ brew untap slp/krunkit | ||
| ``` |
There was a problem hiding this comment.
The shell pipeline to uninstall packages is a bit complex and can be fragile. A simpler and more robust approach is to leverage Homebrew's own user-friendly error messages. Running brew untap will fail if packages are installed, but it will also list them for the user, telling them exactly what to uninstall. This is often a better user experience than a 'magic' one-liner.
| The `slp/krunkit` tap is now deprecated. If you've ever installed `krunkit` from it, you'll need to remove all packages from that tap and then the tap itself: | |
| ``` | |
| $ brew list --full-name | grep "^slp/krunkit/" | xargs brew uninstall | |
| $ brew untap slp/krunkit | |
| ``` | |
| The `slp/krunkit` tap is now deprecated. To remove it, run: |
$ brew untap slp/krunkit
If this fails because packages are installed, uninstall them as
prompted by Homebrew, then run the `untap` command again.
2 participants
We have deprecated the old tap, so extend the instructions to explain how to switch from it to the new one.