docs(extensions): refactor releasing guide and add update mechanisms#26595
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 Gemini CLI extension documentation by clarifying the migration process and providing technical transparency regarding how the CLI handles automatic updates. These changes aim to reduce user confusion and provide better guidance for extension maintainers. Highlights
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 the 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 counterproductive. 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. Footnotes
|
|
Size Change: -4 B (0%) Total Size: 34 MB
ℹ️ View Unchanged
|
![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 extension release documentation by refining the migration guide and adding a new section detailing how update mechanisms function for various installation types, such as GitHub releases and Git clones. A review comment suggests restoring the explicit mention that extension names are updated during migration to ensure clarity for authors renaming their extensions, including a specific code suggestion.
Note: Security Review has been skipped due to the limited scope of the PR.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/extensions/releasing.md (176-178)
The updated text omits the explicit mention that extension names are also updated during migration, which was present in the previous version ('track the new source and name'). Since the CLI supports renaming via the migratedTo property (as implemented in packages/cli/src/config/extension-manager.ts), keeping this explicit is helpful for authors who are renaming their extensions.
Additionally, the phrase 'automatically updates' might be slightly misleading regarding the timing. Based on the implementation in packages/cli/src/config/extensions/update.ts, the migration logic is triggered during the update process. If a user is already on the latest version of the old repository, the transition to the new source may not occur until the next update check or a manual update is initiated. Clarifying this would help set correct expectations for authors.
When users check for updates, Gemini CLI detects the migratedTo field,
verifies the new repository, and automatically updates their local installation
to track the new source and name. All settings migrate automatically.
References
- Maintain consistency in documentation. When information about a feature is present in multiple documents, ensure all instances are updated or removed together to avoid contradictions.
gemini-cli
Bot
added
the
status/need-issue
ruomengz
added
area/extensions
gemini-cli
Bot
added
the
area/documentation
gemini-cli
Bot
added
the
priority/p3
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
2 participants
Summary
Refactor the extension releasing guide and add detailed information about how updates work in Gemini CLI.
Details
Related Issues
#26606
How to Validate
docs/extensions/releasing.md.Pre-Merge Checklist