-
-
Notifications
You must be signed in to change notification settings - Fork 3
feat: improve how to use resource_group in modules #50
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 way resource group configurations are handled within the s3-archive-bucket and sqs-aws-event-queue Terraform modules. The primary goal is to streamline the configuration by consolidating multiple discrete variables into a single, structured object, enhancing consistency and maintainability across the modules.
Highlights
- Module Version Update: The
resource-groupmodule dependency has been updated from version~> 0.10.0to~> 0.12.0in both affected modules. - Resource Group Variable Consolidation: Multiple individual
resource_group_enabled,resource_group_name, andresource_group_descriptionvariables have been replaced by a single, object-basedresource_groupvariable for improved configuration management. - Variable Reference Updates: All internal references to resource group variables within the
s3-archive-bucketandsqs-aws-event-queuemodules have been updated to use the newvar.resource_group.*structure. - New Resource Group Output: A new
resource_groupoutput has been added to both thes3-archive-bucketandsqs-aws-event-queuemodules, exposing the 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 in the s3-archive-bucket and sqs-aws-event-queue modules to use a more modern object-based variable. This is a great improvement for module usability and consistency. The changes are well-implemented across the modules. My review includes suggestions to further improve the new resource_group output by ensuring it has a consistent structure, which will make it more predictable and easier for downstream consumers to use.
| 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 of the resource_group output produces an object with a variable shape. When the resource group is disabled, the output object will be {"enabled": false}, but when enabled, it will include arn and name. This requires consumers of the module to check for the existence of these attributes, which can be error-prone.
To improve the module's usability, it's better to provide a consistent structure for the output, where arn and name are always present, but have null values when the resource group is not created. This makes the output predictable and easier to work with.
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
}
| 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 of the resource_group output produces an object with a variable shape. When the resource group is disabled, the output object will be {"enabled": false}, but when enabled, it will include arn and name. This requires consumers of the module to check for the existence of these attributes, which can be error-prone.
To improve the module's usability, it's better to provide a consistent structure for the output, where arn and name are always present, but have null values when the resource group is not created. This makes the output predictable and easier to work with.
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