From 06ccfe00ce0501ac52017336a64acf3f4dc72ba5 Mon Sep 17 00:00:00 2001
From: Tyler Mizuyabu <tylermizuyabu@gmail.com>
Date: Wed, 6 Mar 2024 10:06:57 -0500
Subject: [PATCH 1/2] fixed docs

---
 modules/private_repository/variables.tf |  2 +-
 modules/public_repository/variables.tf  |  2 +-
 modules/repository_base/variables.tf    |  2 +-
 modules/team/doc.md                     | 38 -------------------------
 4 files changed, 3 insertions(+), 41 deletions(-)
 delete mode 100644 modules/team/doc.md

diff --git a/modules/private_repository/variables.tf b/modules/private_repository/variables.tf
index 1ef5389..5cfde97 100644
--- a/modules/private_repository/variables.tf
+++ b/modules/private_repository/variables.tf
@@ -17,7 +17,7 @@ variable "default_branch" {
 
 variable "repository_team_permissions" {
   type        = map(string)
-  description = "A map where the keys are github team ids and the value is the permissions the team should have in the repository"
+  description = "A map where the keys are github team slugs and the value is the permissions the team should have in the repository"
 }
 
 variable "protected_branches" {
diff --git a/modules/public_repository/variables.tf b/modules/public_repository/variables.tf
index 1ef5389..5cfde97 100644
--- a/modules/public_repository/variables.tf
+++ b/modules/public_repository/variables.tf
@@ -17,7 +17,7 @@ variable "default_branch" {
 
 variable "repository_team_permissions" {
   type        = map(string)
-  description = "A map where the keys are github team ids and the value is the permissions the team should have in the repository"
+  description = "A map where the keys are github team slugs and the value is the permissions the team should have in the repository"
 }
 
 variable "protected_branches" {
diff --git a/modules/repository_base/variables.tf b/modules/repository_base/variables.tf
index 6ebaa59..1dc97a4 100644
--- a/modules/repository_base/variables.tf
+++ b/modules/repository_base/variables.tf
@@ -17,7 +17,7 @@ variable "default_branch" {
 
 variable "repository_team_permissions" {
   type        = map(string)
-  description = "A map where the keys are github team ids and the value is the permissions the team should have in the repository"
+  description = "A map where the keys are github team slugs and the value is the permissions the team should have in the repository"
 }
 
 variable "protected_branches" {
diff --git a/modules/team/doc.md b/modules/team/doc.md
deleted file mode 100644
index eb01c66..0000000
--- a/modules/team/doc.md
+++ /dev/null
@@ -1,38 +0,0 @@
-## Requirements
-
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
-| <a name="requirement_github"></a> [github](#requirement\_github) | 5.44.0 |
-
-## Providers
-
-| Name | Version |
-|------|---------|
-| <a name="provider_github"></a> [github](#provider\_github) | 5.44.0 |
-
-## Modules
-
-No modules.
-
-## Resources
-
-| Name | Type |
-|------|------|
-| [github_team.team](https://registry.terraform.io/providers/integrations/github/5.44.0/docs/resources/team) | resource |
-| [github_team_membership.maintainers](https://registry.terraform.io/providers/integrations/github/5.44.0/docs/resources/team_membership) | resource |
-| [github_team_membership.members](https://registry.terraform.io/providers/integrations/github/5.44.0/docs/resources/team_membership) | resource |
-
-## Inputs
-
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| <a name="input_organization"></a> [organization](#input\_organization) | The organization that the team should be created under. | `string` | n/a | yes |
-| <a name="input_team_description"></a> [team\_description](#input\_team\_description) | Description of the github team to be created. | `string` | `""` | no |
-| <a name="input_team_maintainers"></a> [team\_maintainers](#input\_team\_maintainers) | A list of team maintainers for the github team. These user's will have permissions to manage the team. | `list(string)` | n/a | yes |
-| <a name="input_team_members"></a> [team\_members](#input\_team\_members) | A list of team members for the github team. These user's will not have permissions to manage the team. | `list(string)` | `[]` | no |
-| <a name="input_team_name"></a> [team\_name](#input\_team\_name) | The name to give to the github team that will be created. | `string` | n/a | yes |
-
-## Outputs
-
-No outputs.

From bcd63b3fc3340339c376f3476955dc25007c1c46 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Wed, 6 Mar 2024 15:07:38 +0000
Subject: [PATCH 2/2] terraform-docs: automated action

---
 modules/private_repository/README.md | 2 +-
 modules/public_repository/README.md  | 2 +-
 modules/repository_base/README.md    | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/modules/private_repository/README.md b/modules/private_repository/README.md
index c706d92..61f51ca 100644
--- a/modules/private_repository/README.md
+++ b/modules/private_repository/README.md
@@ -32,7 +32,7 @@ No resources.
 | <a name="input_homepage"></a> [homepage](#input\_homepage) | The homepage for the repository | `string` | `""` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name of the repository to create/import. | `string` | n/a | yes |
 | <a name="input_protected_branches"></a> [protected\_branches](#input\_protected\_branches) | A list of ref names or patterns that should be protected. Defaults `["main"]` | `list(string)` | <pre>[<br>  "main"<br>]</pre> | no |
-| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team ids and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
+| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team slugs and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
 | <a name="input_topics"></a> [topics](#input\_topics) | The topics to apply to the repository | `list(string)` | `[]` | no |
 
 ## Outputs
diff --git a/modules/public_repository/README.md b/modules/public_repository/README.md
index c706d92..61f51ca 100644
--- a/modules/public_repository/README.md
+++ b/modules/public_repository/README.md
@@ -32,7 +32,7 @@ No resources.
 | <a name="input_homepage"></a> [homepage](#input\_homepage) | The homepage for the repository | `string` | `""` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name of the repository to create/import. | `string` | n/a | yes |
 | <a name="input_protected_branches"></a> [protected\_branches](#input\_protected\_branches) | A list of ref names or patterns that should be protected. Defaults `["main"]` | `list(string)` | <pre>[<br>  "main"<br>]</pre> | no |
-| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team ids and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
+| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team slugs and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
 | <a name="input_topics"></a> [topics](#input\_topics) | The topics to apply to the repository | `list(string)` | `[]` | no |
 
 ## Outputs
diff --git a/modules/repository_base/README.md b/modules/repository_base/README.md
index 96c38e6..c4250ab 100644
--- a/modules/repository_base/README.md
+++ b/modules/repository_base/README.md
@@ -44,7 +44,7 @@ No modules.
 | <a name="input_homepage"></a> [homepage](#input\_homepage) | The homepage for the repository | `string` | `""` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name of the repository to create/import. | `string` | n/a | yes |
 | <a name="input_protected_branches"></a> [protected\_branches](#input\_protected\_branches) | A list of ref names or patterns that should be protected. Setting to `[]` means no protection. Defaults `["~DEFAULT_BRANCH"]` | `list(string)` | <pre>[<br>  "~DEFAULT_BRANCH"<br>]</pre> | no |
-| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team ids and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
+| <a name="input_repository_team_permissions"></a> [repository\_team\_permissions](#input\_repository\_team\_permissions) | A map where the keys are github team slugs and the value is the permissions the team should have in the repository | `map(string)` | n/a | yes |
 | <a name="input_secret_scanning"></a> [secret\_scanning](#input\_secret\_scanning) | Enables secret scanning for the repository. If repository is private `advance_security` must also be enabled. | `bool` | `true` | no |
 | <a name="input_secret_scanning_on_push"></a> [secret\_scanning\_on\_push](#input\_secret\_scanning\_on\_push) | Enables secret scanning push protection for the repository. If repository is private `advance_security` must also be enabled. | `bool` | `true` | no |
 | <a name="input_topics"></a> [topics](#input\_topics) | The topics to apply to the repository | `list(string)` | `[]` | no |