Terraform module to configure a GitHub repository within an organization

Note that personal accounts are not supported by this module.

Requires a personal token with the following permissions:

• repo
• read:org
• read:discussion
• workflow (optional)
• delete_repo (optional)

In addition to standard GitHub features, this module also supports:

• Managing branch files
• Managing any files in the repo, e.g. workflows for GitHub Action

How to run

export GITHUB_TOKEN=$(command to get a token from some secret store)
terraform apply --var enforce_admins_enabled=false  # This is only needed when expecting changes in branch files or workflows on branches which require PRs
terraform apply

Example

See variables.tf for configuration options

locals {
  organization_default_branch = "default" # Must match the default branch of the organization

  repos = {
    super-project = {
      description    = "My super project"
      default_branch = "develop" # Must be different from the organization default branch

      branches = {
        develop              = {}
        "release/stable-1.x" = {}
      }
    }
  }
}

provider "github" {
  owner = "your-organization"
}

module "github_repo" {
  source = "git::https://github.com/giner/terraform-github-repo?ref=GIT_COMMIT_ID"

  for_each = local.repos

  organization_default_branch = local.organization_default_branch
  repo_name                   = each.key
  repo_config                 = each.value
}

terraform {
  required_providers {
    github = {
      source = "integrations/github"
    }
  }
}

Contributing

This module is not aimed to be complete as much as it is to be useful. If you have a use case that is not covered by this module, please open an issue or a pull request.