chore: correct config name#2636
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @julienrbrt, 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 naming convention for the main configuration file used throughout the project. The change aims to enhance user experience and developer understanding by aligning the configuration file name with the project's current branding and structure. This ensures that all components consistently refer to the correct configuration artifact.
Highlights
- Configuration File Renaming: The primary configuration file
evolve.yamlhas been renamed toevnode.ymlfor improved clarity and consistency across the project. - Codebase Updates: All references to the old configuration file name have been updated in the Go source code, including initialization commands, error messages, and internal comments.
- Documentation Alignment: Project documentation, including guides and configuration explanations, has been updated to reflect the new
evnode.ymlfile name. - Test Suite Adjustments: Test files have been modified to correctly reference the new configuration file name, ensuring continued test validity.
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. ↩
|
The latest Buf updates on your PR. Results from workflow CI and Release / buf-check (pull_request).
|
|
There was a problem hiding this comment.
Code Review
This pull request aims to standardize the configuration file name to evnode.yml. The changes across documentation and code comments are mostly correct. However, I've identified a critical inconsistency: while user-facing strings are updated to evnode.yml, the underlying code still generates and looks for evnode.yaml due to a constant not being updated. This will lead to confusion and likely bugs. Additionally, I found one place in the documentation where an old config file name (config.yaml) was missed. My review includes comments on these two points.
| ) | ||
|
|
||
| // InitCmd initializes a new evolve.yaml file in the current directory | ||
| // InitCmd initializes a new evnode.yml file in the current directory |
There was a problem hiding this comment.
There's an inconsistency in the configuration file naming. While this comment and other user-facing strings in this PR are updated to evnode.yml, the rollconf.ConfigName constant used programmatically (e.g., in the Long description on line 19) resolves to evnode.yaml. This is because ConfigExtension in pkg/config/defaults.go is still yaml. This discrepancy exists across multiple files and will cause confusion. To resolve this, ConfigExtension in pkg/config/defaults.go should be changed to yml.
| ## Configs | ||
|
|
||
| Evolve configurations can be managed through a YAML file (typically `evolve.yaml` located in `~/.evolve/config/` or `<your_home_dir>/config/`) and command-line flags. The system prioritizes configurations in the following order (highest priority first): | ||
| Evolve configurations can be managed through a YAML file (typically `evnode.yml` located in `~/.evolve/config/` or `<your_home_dir>/config/`) and command-line flags. The system prioritizes configurations in the following order (highest priority first): |
There was a problem hiding this comment.
Good catch updating the config file name here. However, another instance of an old config name was missed nearby. On line 99, config.yaml should also be updated to evnode.yml for consistency.
2 participants
Point to the correct config name,.