-
Notifications
You must be signed in to change notification settings - Fork 10.9k
feat: update .gitignore in /setup-github #6591
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
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 @jerop, 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 introduces an enhancement to the setup-github command within the CLI, automating the process of updating a user's .gitignore file. Upon execution, the command will now ensure that .gemini/ and gha-creds-*.json entries are present in the .gitignore, preventing sensitive or generated files from being inadvertently committed. This improves the initial setup experience by streamlining best practices for file exclusion.
Highlights
- New Functionality: A new updateGitignore function has been implemented to programmatically manage .gitignore entries.
- Automated .gitignore Updates: The setupGithubCommand now integrates this new function, automatically adding .gemini/ and gha-creds-*.json to the user's .gitignore.
- Robustness and Error Handling: The updateGitignore function is robust, handling cases where the .gitignore file doesn't exist, appending to existing files without duplicating entries, and gracefully managing file system errors.
- Test Coverage: Comprehensive unit tests have been added for the new updateGitignore function to ensure its reliability and correct behavior under various scenarios.
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 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
-
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.
Code Review
This pull request introduces a feature to automatically update the user's .gitignore file during the setup-github command. The implementation is mostly correct and includes good test coverage. However, I've identified a significant issue in the logic for checking existing entries in the .gitignore file, which could lead to incorrect behavior. My feedback includes a suggestion to make this check more robust.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
3af7b4e to
4332852
Compare
This feature automatically updates the users .gitignore file during the `setup-github` command. The following changes are included: - A new `updateGitignore` function is added to `packages/cli/src/ui/commands/setupGithubCommand.ts`. This function ensures that the `.gemini/` directory and `gha-creds-*.json` files are added to the users `.gitignore` file. - The `setupGithubCommand` now calls `updateGitignore` to perform this update.
4332852 to
6646e55
Compare
mattKorwel
left a comment
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.
Nice, i like the added test suite, good cases there!
This feature automatically updates the users .gitignore file during the
setup-githubcommand.The following changes are included:
updateGitignorefunction is added topackages/cli/src/ui/commands/setupGithubCommand.ts. This function ensures that the.gemini/directory andgha-creds-*.jsonfiles are added to the users.gitignorefile.setupGithubCommandnow callsupdateGitignoreto perform this update.This is a follow up to google-github-actions/run-gemini-cli#198