This module is a Boldlink opinionated structure adapted to our internal requirements for creating organization repositories. This template creates your custom Github repository, team repositories allowing to configure access, branches and branches protection

• Option to create additional branches when creating the repository.
• Option to set a different branch as your default.
• You get to configure branch protection for your default branch using either github_branch_protection or github_branch_protection_v3.
• Option to create new issue labels for your repository.
• Using this module, you are able to create and manage github action secrets for your repository.
• All github actions secrets are encrypted in conformance with security best practices
• Default configurations have been validated by Checkov to ensure best practices and security.

We use sodium_encrypted_item to encrypt all the secrets being created. This requires the repository's github_actions_public_key and the secret string encoded with base64.

NOTE Both github_branch_protection_v3.main and github_branch_protection.main require an upgrade to github team/enterprise, or the repository to be made public.

Examples available here

NOTE: Github provider is currently locked to version 5.8.0 in the examples as it is the highest stable version that didn't break when we did tests.

NOTE: These examples use the latest version of this module

module "minimum" {
  source      = "boldlink/repository/github"
  name        = "example-minimum"
  description = "Terraform sample github repository "
}

Github Documentation

Terraform module documentation

No modules.

object({
    use_branch_protection    = bool
    use_branch_protection_v3 = bool
  })

{
  "use_branch_protection": false,
  "use_branch_protection_v3": true
}

object({
    dismiss_stale_reviews           = bool
    restrict_dismissals             = bool
    dismissal_restrictions          = list(string)
    pull_request_bypassers          = list(string)
    require_code_owner_reviews      = bool
    required_approving_review_count = number
  })

object({
    dismiss_stale_reviews           = bool
    dismissal_users                 = list(string)
    dismissal_teams                 = list(string)
    require_code_owner_reviews      = bool
    required_approving_review_count = number
  })

object({
    strict   = bool
    contexts = list(string)
  })

object({
    users = list(string)
    teams = list(string)
    apps  = list(string)
  })

object({
    owner      = string
    repository = string
  })

This repository uses third party software:

• pre-commit - Used to help ensure code and documentation consistency
  • Install with brew install pre-commit
  • Manually use with pre-commit run
• terraform 0.14.11 For backwards compatibility we are using version 0.14.11 for testing making this the min version tested and without issues with terraform-docs.
• terraform-docs - Used to generate the Inputs and Outputs sections
  • Install with brew install terraform-docs
  • Manually use via pre-commit
• tflint - Used to lint the Terraform code
  • Install with brew install tflint
  • Manually use via pre-commit