Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 6.24 KB

README.md

File metadata and controls

42 lines (31 loc) · 6.24 KB
Raw

terraform-github-organisation

OpsHeaven's Terraform module to manage GitHub Organizations.

Examples

Requirements

Name Version
terraform ~> 1.7
github ~> 6.0

Providers

Name Version
github 6.0.0

Inputs

Name Description Type Default Required
action_permissions Organisational level Github Actions permissions 
object({
    allowed_actions      = optional(string, "selected")
    enabled_repositories = optional(string, "all")
    github_owned_allowed = optional(bool, true)
    patterns_allowed     = optional(list(string), [])
    verified_allowed     = optional(bool, false)
  })
 n/a yes
members Organisation members 
map(object({
    role    = string
    blocked = optional(bool, false)
    teams   = optional(list(string), [])
  }))
 n/a yes
organisation GitHub organization settings. 
object({
    name                                                         = string
    company                                                      = string
    description                                                  = string
    email                                                        = optional(string, "")
    billing_email                                                = string
    blog                                                         = optional(string, "")
    twitter_username                                             = optional(string, "")
    location                                                     = optional(string, "")
    has_organization_projects                                    = optional(bool, false)
    has_repository_projects                                      = optional(bool, false)
    default_repository_permission                                = optional(string, "read")
    members_can_create_repositories                              = optional(bool, false)
    members_can_create_public_repositories                       = optional(bool, false)
    members_can_create_private_repositories                      = optional(bool, false)
    members_can_create_internal_repositories                     = optional(bool, false)
    members_can_create_pages                                     = optional(bool, false)
    members_can_create_public_pages                              = optional(bool, false)
    members_can_create_private_pages                             = optional(bool, false)
    members_can_fork_private_repositories                        = optional(bool, false)
    web_commit_signoff_required                                  = optional(bool, true)
    advanced_security_enabled_for_new_repositories               = optional(bool, true)
    dependabot_alerts_enabled_for_new_repositories               = optional(bool, true)
    dependabot_security_updates_enabled_for_new_repositories     = optional(bool, true)
    dependency_graph_enabled_for_new_repositories                = optional(bool, true)
    secret_scanning_enabled_for_new_repositories                 = optional(bool, true)
    secret_scanning_push_protection_enabled_for_new_repositories = optional(bool, true)
  })
 n/a yes
repositories Organisation repositories 
map(object({
    description                 = string
    visibility                  = optional(string, "public")
    has_issues                  = optional(bool, false)
    has_downloads               = optional(bool, false)
    has_discussions             = optional(bool, false)
    has_projects                = optional(bool, false)
    has_wiki                    = optional(bool, false)
    is_template                 = optional(bool, false)
    allow_update_branch         = optional(bool, false)
    allow_merge_commit          = optional(bool, false)
    allow_squash_merge          = optional(bool, true)
    allow_rebase_merge          = optional(bool, true)
    allow_auto_merge            = optional(bool, false)
    archived                    = optional(bool, false)
    delete_branch_on_merge      = optional(bool, true)
    default_branch              = optional(string, "main")
    homepage_url                = optional(string, "")
    topics                      = optional(list(string), [])
    web_commit_signoff_required = optional(bool, true)
    issue_labels                = optional(map(string), {})
    status_checks               = optional(list(string), [])
  }))
 {} no
teams Teams of the organisation 
map(object({
    description                    = string
    privacy                        = string
    all_users_team                 = optional(bool, false)
    reviewer_asssignment_algorithm = optional(string, "LOAD_BALANCE")
    required_reviewer_count        = optional(number, 1)
    enable_pr_notification         = optional(bool, true)
    repo_permission                = optional(string, "read")
    repo_permission_override       = optional(map(string), {})
  }))
 {} no

Outputs

Name Description
displayname Organisation Display Name
members Organisation members
name Organisation Name
teams Teams with github identifiers