feat: Condense repo config file variables (#2)

Author: jakubigla

README.md

@@ -64,10 +64,7 @@ module "template" {
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_repo_config_file_format"></a> [repo\_config\_file\_format](#input\_repo\_config\_file\_format) | Format of the repo config file that will be generated. Possible values: yaml or json | `string` | `"yaml"` | no |
-| <a name="input_repo_config_file_generation_enabled"></a> [repo\_config\_file\_generation\_enabled](#input\_repo\_config\_file\_generation\_enabled) | Indicates wherever the config file should be generated | `bool` | `false` | no |
-| <a name="input_repo_config_file_name"></a> [repo\_config\_file\_name](#input\_repo\_config\_file\_name) | Name of the repo config file | `string` | `"repo_config.yaml"` | no |
-| <a name="input_repo_config_file_path"></a> [repo\_config\_file\_path](#input\_repo\_config\_file\_path) | Path where the repo config file should be generated | `string` | `"."` | no |
+| <a name="input_repo_config_file"></a> [repo\_config\_file](#input\_repo\_config\_file) | Configures config file generation if enabled | <pre>object({<br>    enabled = optional(bool, false)<br>    path    = optional(string, ".")<br>    name    = optional(string, "repo_config.yaml")<br>    format  = optional(string, "yaml")<br>  })</pre> | `{}` | no |
 | <a name="input_repos"></a> [repos](#input\_repos) | Map of repositories and their configs. Refer to https://www.runatlantis.io/docs/server-side-repo-config.html#example-server-side-repo | <pre>list(object({<br>    id                            = optional(string, "/.*/")<br>    branch                        = optional(string)<br>    apply_requirements            = optional(list(string))<br>    allowed_overrides             = optional(list(string))<br>    allowed_workflows             = optional(list(string))<br>    allow_custom_workflows        = optional(bool)<br>    delete_source_branch_on_merge = optional(bool)<br>    pre_workflow_hooks = optional(list(object({<br>      run = string<br>    })))<br>    post_workflow_hooks = optional(list(object({<br>      run = string<br>    })))<br>    workflow = optional(string)<br>    ######### Helpers #########<br>    allow_all_server_side_workflows = optional(bool, false)<br>    terragrunt_atlantis_config = optional(object({<br>      enabled              = optional(bool, false)<br>      output               = optional(string, "atlantis.yaml")<br>      automerge            = optional(bool)<br>      autoplan             = optional(bool)<br>      parallel             = optional(bool)<br>      cascade_dependencies = optional(bool)<br>      filter               = optional(string)<br>      use_project_markers  = optional(bool)<br>    }), {})<br>  }))</pre> | `[]` | no |
 | <a name="input_repos_common_config"></a> [repos\_common\_config](#input\_repos\_common\_config) | Common config that will be merged into each item of the repos list | <pre>object({<br>    id                            = optional(string)<br>    branch                        = optional(string)<br>    apply_requirements            = optional(list(string))<br>    allowed_overrides             = optional(list(string))<br>    allowed_workflows             = optional(list(string))<br>    allow_custom_workflows        = optional(bool)<br>    delete_source_branch_on_merge = optional(bool)<br>    pre_workflow_hooks = optional(list(object({<br>      run = string<br>    })))<br>    post_workflow_hooks = optional(list(object({<br>      run = string<br>    })))<br>    workflow = optional(string)<br>    ######### Helpers #########<br>    allow_all_server_side_workflows = optional(bool, false)<br>    terragrunt_atlantis_config = optional(object({<br>      enabled  = optional(bool, false)<br>      output   = optional(string, "atlantis.yaml")<br>      autoplan = optional(bool, false)<br>      parallel = optional(bool, false)<br>      filter   = optional(string)<br>    }), {})<br>  })</pre> | `{}` | no |
 | <a name="input_use_predefined_workflows"></a> [use\_predefined\_workflows](#input\_use\_predefined\_workflows) | Indicates wherever predefined workflows should be added to the generated repo config file | `bool` | `true` | no |

examples/complete/main.tf

@@ -44,5 +44,7 @@ module "repo_config" {
     }
   }
 
-  repo_config_file_generation_enabled = true
+  repo_config_file = {
+    enabled = true
+  }
 }

main.tf

@@ -53,11 +53,11 @@ locals {
 }
 
 resource "local_file" "repo_config" {
-  count = var.repo_config_file_generation_enabled ? 1 : 0
-  content = (var.repo_config_file_format == "json"
+  count = var.repo_config_file.enabled ? 1 : 0
+  content = (var.repo_config_file.format == "json"
     ? local.repo_config_json
     : local.repo_config_yaml
   )
-  filename        = format("%s/%s", var.repo_config_file_path, var.repo_config_file_name)
+  filename        = format("%s/%s", var.repo_config_file.path, var.repo_config_file.name)
   file_permission = "0644"
 }

variables.tf

@@ -83,31 +83,18 @@ variable "use_predefined_workflows" {
   default     = true
 }
 
-variable "repo_config_file_generation_enabled" {
-  description = "Indicates wherever the config file should be generated"
-  type        = bool
-  default     = false
-}
-
-variable "repo_config_file_path" {
-  description = "Path where the repo config file should be generated"
-  type        = string
-  default     = "."
-}
-
-variable "repo_config_file_name" {
-  description = "Name of the repo config file"
-  type        = string
-  default     = "repo_config.yaml"
-}
-
-variable "repo_config_file_format" {
-  description = "Format of the repo config file that will be generated. Possible values: yaml or json"
-  type        = string
-  default     = "yaml"
+variable "repo_config_file" {
+  description = "Configures config file generation if enabled"
+  type = object({
+    enabled = optional(bool, false)
+    path    = optional(string, ".")
+    name    = optional(string, "repo_config.yaml")
+    format  = optional(string, "yaml")
+  })
+  default = {}
 
   validation {
-    condition     = contains(["yaml", "json"], var.repo_config_file_format)
+    condition     = contains(["yaml", "json"], var.repo_config_file.format)
     error_message = "Invalid format provided. Allowed values: yaml, json"
   }
 }