chore: Mark defaults as deprecated.

Author: mariux

README.md

@@ -124,32 +124,10 @@ See [variables.tf] and [examples/] for details and use-cases.
 
 - [**`defaults`**](#var-defaults): *(Optional `object(defaults)`)*<a name="var-defaults"></a>
 
-  A object of default settings to use instead of module defaults for top-level arguments.
-  See below for a list of supported arguments.
-
-  This is a special argument to set various defaults to be reused for multiple repositories.
-
-  The following top-level arguments can be set as defaults:
-  `homepage_url`,
-  `visibility`,
-  `has_issues`,
-  `has_projects`,
-  `has_wiki`,
-  `allow_merge_commit`,
-  `allow_rebase_merge`,
-  `allow_squash_merge`,
-  `allow_auto_merge`,
-  `has_downloads`,
-  `auto_init`,
-  `gitignore_template`,
-  `license_template`,
-  `default_branch`,
-  `topics`,
-  `issue_labels_create`,
-  `issue_labels_merge_with_github_labels`.
-
-  Module defaults are used for all arguments that are not set in `defaults`.
-  Using top level arguments override defaults set by this argument.
+  DEPRECATED:
+  This variable will be removed in future releases.
+  It was needed in times when Terraform Module for each was not available to provide default values for multiple repositories.
+  Please convert your code accordingly to stay compatible with future releases.
 
   Default is `{}`.
 

README.tfdoc.hcl

@@ -140,32 +140,10 @@ section {
         type        = object(defaults)
         default     = {}
         description = <<-END
-          A object of default settings to use instead of module defaults for top-level arguments.
-          See below for a list of supported arguments.
-
-          This is a special argument to set various defaults to be reused for multiple repositories.
-
-          The following top-level arguments can be set as defaults:
-          `homepage_url`,
-          `visibility`,
-          `has_issues`,
-          `has_projects`,
-          `has_wiki`,
-          `allow_merge_commit`,
-          `allow_rebase_merge`,
-          `allow_squash_merge`,
-          `allow_auto_merge`,
-          `has_downloads`,
-          `auto_init`,
-          `gitignore_template`,
-          `license_template`,
-          `default_branch`,
-          `topics`,
-          `issue_labels_create`,
-          `issue_labels_merge_with_github_labels`.
-
-          Module defaults are used for all arguments that are not set in `defaults`.
-          Using top level arguments override defaults set by this argument.
+          DEPRECATED:
+          This variable will be removed in future releases.
+          It was needed in times when Terraform Module for each was not available to provide default values for multiple repositories.
+          Please convert your code accordingly to stay compatible with future releases.
         END
       }
 

variables.tf

@@ -25,30 +25,9 @@ variable "branches" {
 }
 
 variable "defaults" {
-  description = "(Optional) Overwrite defaults for various repository settings"
+  description = "(Deprecated) DEPRECATED. Please convert defaults to Terraform Module for_each"
   type        = any
-
-  # Example:
-  # defaults = {
-  #   homepage_url           = "https://mineiros.io/"
-  #   visibility             = "private"
-  #   has_issues             = false
-  #   has_projects           = false
-  #   has_wiki               = false
-  #   delete_branch_on_merge = true
-  #   allow_merge_commit     = true
-  #   allow_rebase_merge     = false
-  #   allow_squash_merge     = false
-  #   allow_auto_merge       = false
-  #   has_downloads          = false
-  #   auto_init              = true
-  #   gitignore_template     = "terraform"
-  #   license_template       = "mit"
-  #   default_branch         = "main"
-  #   topics                 = ["topic-1", "topic-2"]
-  # }
-
-  default = {}
+  default     = {}
 }
 
 variable "description" {