|
| 1 | +# org-team |
| 2 | + |
| 3 | +This module creates following resources. |
| 4 | + |
| 5 | +- `github_team` |
| 6 | +- `github_team_membership` (optional) |
| 7 | + |
| 8 | +<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 9 | +## Requirements |
| 10 | + |
| 11 | +| Name | Version | |
| 12 | +|------|---------| |
| 13 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.1 | |
| 14 | +| <a name="requirement_github"></a> [github](#requirement\_github) | = 4.13.0 | |
| 15 | + |
| 16 | +## Providers |
| 17 | + |
| 18 | +| Name | Version | |
| 19 | +|------|---------| |
| 20 | +| <a name="provider_github"></a> [github](#provider\_github) | 4.13.0 | |
| 21 | + |
| 22 | +## Modules |
| 23 | + |
| 24 | +No modules. |
| 25 | + |
| 26 | +## Resources |
| 27 | + |
| 28 | +| Name | Type | |
| 29 | +|------|------| |
| 30 | +| [github_team.this](https://registry.terraform.io/providers/hashicorp/github/4.13.0/docs/resources/team) | resource | |
| 31 | +| [github_team_membership.this](https://registry.terraform.io/providers/hashicorp/github/4.13.0/docs/resources/team_membership) | resource | |
| 32 | + |
| 33 | +## Inputs |
| 34 | + |
| 35 | +| Name | Description | Type | Default | Required | |
| 36 | +|------|-------------|------|---------|:--------:| |
| 37 | +| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the team. | `string` | n/a | yes | |
| 38 | +| <a name="input_default_maintainer_enabled"></a> [default\_maintainer\_enabled](#input\_default\_maintainer\_enabled) | (Optional) If true, adds the creating user as a default maintainer to the team. | `bool` | `false` | no | |
| 39 | +| <a name="input_description"></a> [description](#input\_description) | (Optional) A description of the team. | `string` | `"Managed by Terraform."` | no | |
| 40 | +| <a name="input_is_secret"></a> [is\_secret](#input\_is\_secret) | (Optional) If true, team is only visible to the people on the team and people with owner permissions. | `bool` | `false` | no | |
| 41 | +| <a name="input_ldap_group_dn"></a> [ldap\_group\_dn](#input\_ldap\_group\_dn) | (Optional) The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. | `string` | `null` | no | |
| 42 | +| <a name="input_maintainers"></a> [maintainers](#input\_maintainers) | (Optional) A list of usernames to add users as `maintainer` role. When applied, the user will become a maintainer of the team. | `set(string)` | `[]` | no | |
| 43 | +| <a name="input_members"></a> [members](#input\_members) | (Optional) A list of usernames to add users as `member` role. When applied, the user will become a member of the team. | `set(string)` | `[]` | no | |
| 44 | +| <a name="input_parent_id"></a> [parent\_id](#input\_parent\_id) | (Optional) The ID of the parent team, if this is a nested team. | `string` | `null` | no | |
| 45 | + |
| 46 | +## Outputs |
| 47 | + |
| 48 | +| Name | Description | |
| 49 | +|------|-------------| |
| 50 | +| <a name="output_default_maintainer_enabled"></a> [default\_maintainer\_enabled](#output\_default\_maintainer\_enabled) | Whether to add the creating user as a default maintainer. | |
| 51 | +| <a name="output_description"></a> [description](#output\_description) | The description of the team. | |
| 52 | +| <a name="output_id"></a> [id](#output\_id) | The ID of the team. | |
| 53 | +| <a name="output_is_secret"></a> [is\_secret](#output\_is\_secret) | Whether to be only visible to the people on the team and people with owner permissions. | |
| 54 | +| <a name="output_ldap_group_dn"></a> [ldap\_group\_dn](#output\_ldap\_group\_dn) | The LDAP Distinguished Name of the group where membership will be synchronized. | |
| 55 | +| <a name="output_maintainers"></a> [maintainers](#output\_maintainers) | A list of the maintainers of the team. | |
| 56 | +| <a name="output_members"></a> [members](#output\_members) | A list of the members of the team. | |
| 57 | +| <a name="output_name"></a> [name](#output\_name) | The name of the team. | |
| 58 | +| <a name="output_node_id"></a> [node\_id](#output\_node\_id) | The Node ID of the team. | |
| 59 | +| <a name="output_parent_id"></a> [parent\_id](#output\_parent\_id) | The ID of the parent team. | |
| 60 | +| <a name="output_slug"></a> [slug](#output\_slug) | The slug of the team. | |
| 61 | +<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
0 commit comments