Skip to main content
Sponsor @cloudposse

Module: repository

Terraform Module to provision a GitHub Repository with advanced settings.

Introduction​

Terraform Module to provision a GitHub Repository with advanced settings:

  • Repository
  • Environments
  • Deploy Keys
  • Rulesets
  • Secrets
  • Variables
  • Custom Properties
  • Webhooks
  • Autolink References
  • Labels
  • Collaborators

Usage​

For a complete example, see examples/complete.

module "github_repository" {
  source  = "cloudposse/repository/github"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  name = "my-repository"
  description = "My repository"
  visibility = "public"
  auto_init = true
  has_issues = true
  has_projects = true
  has_wiki = true
  has_downloads = true
  is_template = false
}

Examples​

Here is an example of using this module:

Variables​

Required Variables​

Optional Variables​

allow_auto_merge (bool) optional

Allow auto merge


Default value: false

allow_merge_commit (bool) optional

Allow merge commit


Default value: true

allow_rebase_merge (bool) optional

Allow rebase merge


Default value: true

allow_squash_merge (bool) optional

Allow squash merge


Default value: true

allow_update_branch (bool) optional

Allow updating the branch


Default value: false

archive_on_destroy (bool) optional

Archive the repository on destroy


Default value: false

archived (bool) optional

Whether the repository is archived


Default value: false

auto_init (bool) optional

Auto-initialize the repository


Default value: false

autolink_references optional

Autolink references


Type:

map(object({
key_prefix          = string
target_url_template = string
is_alphanumeric     = optional(bool, false)
}))

Default value: { }

custom_properties optional

Custom properties for the repository


Type:

map(object({
string        = optional(string, null)
boolean       = optional(bool, null)
single_select = optional(string, null)
multi_select  = optional(list(string), null)
}))

Default value: { }

default_branch (string) optional

Default branch name


Default value: "main"

delete_branch_on_merge (bool) optional

Delete branch on merge


Default value: false

deploy_keys optional

Deploy keys for the repository


Type:

map(object({
title     = string
key       = string
read_only = optional(bool, false)
}))

Default value: { }

description (string) optional

Description of the repository


Default value: null

enable_vulnerability_alerts (bool) optional

Enable vulnerability alerts


Default value: true

environments optional

Environments for the repository. Enviroment secrets should be encrypted using the GitHub public key in Base64 format if prefixed with nacl:. Read more: https://docs.github.com/en/actions/security-for-github-actions/encrypted-secrets


Type:

map(object({
wait_timer          = optional(number, 0)
can_admins_bypass   = optional(bool, false)
prevent_self_review = optional(bool, false)
reviewers = optional(object({
  teams = optional(list(string), [])
  users = optional(list(string), [])
}), null)
deployment_branch_policy = optional(object({
  protected_branches = optional(bool, false)
  custom_branches = optional(object({
    branches = optional(list(string), null)
    tags     = optional(list(string), null)
  }), null)
}), null)
variables = optional(map(string), null)
secrets   = optional(map(string), null)
}))

Default value: { }

gitignore_template (string) optional

Gitignore template


Default value: null

has_discussions (bool) optional

Whether the repository has discussions enabled


Default value: false

has_downloads (bool) optional

Whether the repository has downloads enabled


Default value: false

has_issues (bool) optional

Whether the repository has issues enabled


Default value: false

has_projects (bool) optional

Whether the repository has projects enabled


Default value: false

has_wiki (bool) optional

Whether the repository has wiki enabled


Default value: false

homepage_url (string) optional

Homepage URL of the repository


Default value: null

ignore_vulnerability_alerts_during_read (bool) optional

Ignore vulnerability alerts during read


Default value: false

is_template (bool) optional

Whether the repository is a template


Default value: false

labels optional

A map of labels to configure for the repository


Type:

map(object({
color       = string
description = string
}))

Default value: { }

license_template (string) optional

License template


Default value: null

merge_commit_message (string) optional

Merge commit message. Must be PR_BODY, PR_TITLE or BLANK.


Default value: "PR_BODY"

merge_commit_title (string) optional

Merge commit title. Must be PR_TITLE or MERGE_MESSAGE.


Default value: "PR_TITLE"

rulesets optional

A map of rulesets to configure for the repository


Type:

map(object({
name = string
// disabled, active
enforcement = string
// branch, tag
target = string
bypass_actors = optional(list(object({
  // always, pull_request
  bypass_mode = string
  actor_id    = optional(string, null)
  // RepositoryRole, Team, Integration, OrganizationAdmin
  actor_type = string
})), [])
conditions = object({
  ref_name = object({
    // Supports ~DEFAULT_BRANCH or ~ALL
    include = optional(list(string), [])
    exclude = optional(list(string), [])
  })
})
rules = object({
  branch_name_pattern = optional(object({
    // starts_with, ends_with, contains, regex
    operator = string
    pattern  = string
    name     = optional(string, null)
    negate   = optional(bool, false)
  }), null),
  commit_author_email_pattern = optional(object({
    // starts_with, ends_with, contains, regex
    operator = string
    pattern  = string
    name     = optional(string, null)
    negate   = optional(bool, false)
  }), null),
  creation         = optional(bool, false),
  deletion         = optional(bool, false),
  non_fast_forward = optional(bool, false),
  required_pull_request_reviews = optional(object({
    dismiss_stale_reviews           = bool
    required_approving_review_count = number
  }), null),
  commit_message_pattern = optional(object({
    // starts_with, ends_with, contains, regex
    operator = string
    pattern  = string
    name     = optional(string, null)
    negate   = optional(bool, false)
  }), null),
  committer_email_pattern = optional(object({
    // starts_with, ends_with, contains, regex
    operator = string
    pattern  = string
    name     = optional(string, null)
    negate   = optional(bool, false)
  }), null),
  merge_queue = optional(object({
    check_response_timeout_minutes = optional(number, 60)
    // ALLGREEN, HEADGREEN
    grouping_strategy    = string
    max_entries_to_build = optional(number, 5)
    max_entries_to_merge = optional(number, 5)
    // MERGE, SQUASH, REBASE
    merge_method                      = optional(string, "MERGE")
    min_entries_to_merge              = optional(number, 1)
    min_entries_to_merge_wait_minutes = optional(number, 5)
  }), null),
  pull_request = optional(object({
    dismiss_stale_reviews_on_push     = optional(bool, false)
    require_code_owner_review         = optional(bool, false)
    require_last_push_approval        = optional(bool, false)
    required_approving_review_count   = optional(number, 0)
    required_review_thread_resolution = optional(bool, false)
  }), null),
  required_deployments = optional(object({
    required_deployment_environments = optional(list(string), [])
  }), null),
  required_status_checks = optional(object({
    required_check = list(object({
      context        = string
      integration_id = optional(number, null)
    }))
    strict_required_status_checks_policy = optional(bool, false)
    do_not_enforce_on_create             = optional(bool, false)
  }), null),
  tag_name_pattern = optional(object({
    // starts_with, ends_with, contains, regex
    operator = string
    pattern  = string
    name     = optional(string, null)
    negate   = optional(bool, false)
  }), null),
  // Unsupported due to drift.
  // https://github.com/integrations/terraform-provider-github/pull/2701
  # required_code_scanning = optional(object({
  #   required_code_scanning_tool = list(object({
  #     // none, errors, errors_and_warnings, all
  #     alerts_threshold          = string
  #     // none, critical, high_or_higher, medium_or_higher, all
  #     security_alerts_threshold = string
  #     tool                      = string
  #   }))
  # }), null),
}),
}))

Default value: { }

secrets (map(string)) optional

Secrets for the repository (if prefixed with nacl: it should be encrypted value using the GitHub public key in Base64 format. Read more: https://docs.github.com/en/actions/security-for-github-actions/encrypted-secrets)


Default value: { }

security_and_analysis optional

Security and analysis settings


Type:

object({
advanced_security               = bool
secret_scanning                 = bool
secret_scanning_push_protection = bool
})

Default value: null

squash_merge_commit_message (string) optional

Squash merge commit message. Must be PR_BODY, COMMIT_MESSAGES or BLANK.


Default value: "COMMIT_MESSAGE"

squash_merge_commit_title (string) optional

Squash merge commit title. Must be PR_TITLE or COMMIT_OR_PR_TITLE.


Default value: "PR_TITLE"

teams (map(string)) optional

A map of teams and their permissions for the repository


Default value: { }

template optional

Template repository


Type:

object({
owner                = string
name                 = string
include_all_branches = optional(bool, false)
})

Default value: null

topics (list(string)) optional

List of repository topics


Default value: [ ]

users (map(string)) optional

A map of users and their permissions for the repository


Default value: { }

variables (map(string)) optional

Environment variables for the repository


Default value: { }

visibility (string) optional

Visibility of the repository. Must be public, private, or internal.


Default value: "public"

web_commit_signoff_required (bool) optional

Require signoff on web commits


Default value: false

webhooks optional

A map of webhooks to configure for the repository


Type:

map(object({
active       = optional(bool, true)
events       = list(string)
url          = string
content_type = optional(string, "json")
insecure_ssl = optional(bool, false)
secret       = optional(string, null)
}))

Default value: { }

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

collaborators_invitation_ids

Collaborators invitation IDs

full_name

Full name of the created repository

git_clone_url

Git clone URL of the created repository

html_url

HTML URL of the created repository

http_clone_url

SSH clone URL of the created repository

node_id

Node ID of the created repository

primary_language

Primary language of the created repository

repo_id

Repository ID of the created repository

rulesets_etags

Rulesets etags

rulesets_node_ids

Rulesets node IDs

rulesets_rules_ids

Rulesets rules IDs

ssh_clone_url

SSH clone URL of the created repository

svn_url

SVN URL of the created repository

webhooks_urls

Webhooks URLs

Dependencies​

Requirements​

  • terraform, version: >= 1.0
  • github, version: >= 6.6.0

Providers​

  • github, version: >= 6.6.0

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: