-
-
Notifications
You must be signed in to change notification settings - Fork 3
feat: improve how to use resource_group in modules #112
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 how resource group configurations are handled across various AWS modules. By consolidating multiple individual variables into a single object, it streamlines the module interface and enhances consistency, making it easier to manage and configure resource groups.
Highlights
- Module Version Update: The
resource-groupmodule version has been updated from~> 0.10.0to~> 0.12.0across all affected modules. - Resource Group Variable Consolidation: Individual
resource_group_enabled,resource_group_name, andresource_group_descriptionvariables have been replaced by a single, object-basedresource_groupvariable for improved configuration. - Reference Updates: All internal references within the modules have been updated to use the new
var.resource_group.*structure, ensuring consistency with the new object-based pattern. - New Resource Group Output: A new
resource_groupoutput has been added to each updated module, providing details like ARN and name of the managed 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 across multiple modules to use a more modern object-based pattern, which is a great improvement for consistency and usability. The changes are well-executed, replacing individual variables with a single resource_group object and updating the module dependencies.
My review focuses on improving the implementation of the new resource_group output in each module. I've suggested a simplification that ensures a consistent output structure, making the modules easier and more reliable for consumers. This change will improve the overall maintainability and robustness of the modules.
| 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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].name, null)
}
| { | ||
| 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.
For better module usability, it's recommended that outputs have a consistent object shape. The current implementation changes the shape of the output object based on whether the resource group is created. This can make it harder for module consumers to use the output, as they need to check for the existence of arn and name attributes.
A better approach is to always include these attributes, but set them to null when the resource group is not created. This can be achieved more cleanly and concisely using the try() function.
value = {
enabled = var.resource_group.enabled && var.module_tags_enabled
arn = try(module.resource_group[0].arn, null)
name = try(module.resource_group[0].name, null)
}
14dbd9f to
37e984b
Compare
Summary
Update resource group configuration to use object-based pattern.
Changes
Modules Updated
Test Plan