-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat(sfn-state-machine): improve how to use resource_group in module #21
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 @posquit0, 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 refactors the resource group configuration within the sfn-state-machine
module. The primary goal is to streamline variable management by consolidating multiple individual resource group settings into a single, more organized object variable. This change enhances the module's interface by simplifying how resource group properties are passed and consumed, leading to a cleaner and more maintainable codebase.
Highlights
- Module Version Update: The module version for the
resource-group
submodule has been updated from~> 0.10.0
to~> 0.12.0
. - Variable Consolidation: Individual
resource_group_*
variables (e.g.,resource_group_enabled
,resource_group_name
,resource_group_description
) have been replaced with a single, object-basedresource_group
variable. - Reference Updates: All internal references within the module have been updated to use the new
var.resource_group.*
structure, ensuring consistency with the new object-based variable. - New Output Added: A new
resource_group
output has been added to thesfn-state-machine
module, providing details like ARN and name of the created resource group.
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 refactors the resource group configuration to use a more modern object-based pattern, which is a great improvement for the module's interface. The changes are well-implemented across the module. I have one suggestion in outputs.tf
to improve the structure of the new resource_group
output to make it more consistent and easier to consume.
value = merge( | ||
{ | ||
enabled = var.resource_group.enabled && var.module_tags_enabled | ||
}, | ||
(var.resource_group.enabled && var.module_tags_enabled | ||
? { | ||
arn = module.resource_group[0].arn | ||
name = module.resource_group[0].name | ||
} | ||
: {} | ||
) | ||
) |
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.
The current implementation using merge
produces an output with an inconsistent structure, which can be difficult for consumers of the module. It can be simplified and improved by using a single conditional expression. This will make the code more readable and ensure the output object always has the same set of keys (enabled
, arn
, name
), which is a best practice for module outputs.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
arn = null
name = null
}
Summary
Update resource group configuration to use object-based pattern.
Changes
Modules Updated
Test Plan