Skip to content

Latest commit

 

History

History

org-team

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

org-team

This module creates following resources.

  • github_team
  • github_team_settings
  • github_team_sync_group_mapping
  • github_team_members (optional)
  • github_team_membership (optional)

Requirements

Name Version
terraform >= 1.9
github >= 6.2

Providers

Name Version
github 6.2.2

Modules

No modules.

Resources

Name Type
github_team.this resource
github_team_members.this resource
github_team_membership.this resource
github_team_settings.this resource
github_team_sync_group_mapping.this resource
github_organization_team_sync_groups.this data source

Inputs

Name Description Type Default Required
name (Required) The name of the team. string n/a yes
code_review_auto_assignment (Optional) A configuration for code review auto assignment. code_review_auto_assignment block as defined below.
(Optional) enabled - Whether to enable code review auto assignment. Defaults to false.
(Optional) algorithm - The algorithm to use for code review auto assignment. Valid values are ROUND_ROBIN or LOAD_BALANCE. Defaults to ROUND_ROBIN.
(Optional) assignment_count - The number of reviewers to assign for each pull request.
(Optional) notify_team_enabled - Whether to notify the entire team when both a team and one or more of its members are requested for review. Defaults to false.
object({
enabled = optional(bool, false)
algorithm = optional(string, "ROUND_ROBIN")
assignment_count = optional(number)

notify_team_enabled = optional(bool, false)
})
{} no
default_maintainer_enabled (Optional) If true, adds the creating user as a default maintainer to the team. Defaults to false. bool false no
description (Optional) A description of the team. string "Managed by Terraform." no
identity_provider_team_sync (Optional) A configuration to manage team members using your identity provider groups. identity_provider_team_sync block as defined below.
(Optional) enabled - Whether to enable team synchronization between your identity provider (IdP) and your organization on GitHub. Defaults to false.
(Optional) groups - A set of group names to sync with the team.
object({
enabled = optional(bool, false)
groups = optional(set(string), [])
})
{} no
is_secret (Optional) If true, team is only visible to the people on the team and people with owner permissions. Defaults to false. bool false no
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
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
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
membership_sync_enabled (Optional) Whether to sync the members of the team. Members added outside of the Terraform code will be removed. Defaults to false. bool false no
parent_id (Optional) The ID of the parent team, if this is a nested team. string null no

Outputs

Name Description
code_review_auto_assignment A configuration for code review auto assignment.
default_maintainer_enabled Whether to add the creating user as a default maintainer.
description The description of the team.
id The ID of the team.
identity_provider_team_sync A configuration to manage team members using your identity provider groups.
is_secret Whether to be only visible to the people on the team and people with owner permissions.
ldap_group_dn The LDAP Distinguished Name of the group where membership will be synchronized.
maintainers A list of the maintainers of the team.
members A list of the members of the team.
name The name of the team.
node_id The Node ID of the team.
parent_id The ID of the parent team.
slug The slug of the team.