Terraform module to manage GitHub repositories
No requirements.
Name | Version |
---|---|
github | n/a |
Name | Description | Type | Default | Required |
---|---|---|---|---|
archived | (optional) Archives the repository if set to true | bool |
false |
no |
auto_init | (optional) Meaningful only during create, set to true to produce an initial commit in the repository | bool |
true |
no |
branch_protection_enabled | (optional) Control branch protection for the defaault branch | bool |
true |
no |
default_branch_name | (optional) Default branch name and the branch name with protection applied to it | string |
"main" |
no |
delete_branch_on_merge | (optional) Automatically delete head branch after a pull request is merged | bool |
true |
no |
description | (optional) Repository description. Leave blank for default of: Development repository | string |
"Development repository" |
no |
dismiss_stale_reviews | (optional) Dismiss approved reviews automatically when a new commit is pushed | bool |
true |
no |
enforce_admins | (optional) Enforce status checks for repository administrators | bool |
true |
no |
has_downloads | (optional) Enables GitHub issues | bool |
false |
no |
has_issues | (optional) Enables GitHub issues | bool |
false |
no |
has_projects | (optional) Enables GitHub projects | bool |
false |
no |
has_wiki | (optional) Enables GitHub wiki | bool |
false |
no |
homepage_url | (optional) Home page URL for the Git repo | string |
"" |
no |
name | Name of the repository | string |
n/a | yes |
require_ci_pass | (optional) Require all CI checks listed in status_checks to pass | bool |
true |
no |
require_code_owner_reviews | (optional) Require an approved review in pull requests including files with a designated code owner | bool |
false |
no |
required_approving_review_count | (optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6 | number |
1 |
no |
status_checks | (optional) A list of required passing CI checks | list |
[] |
no |
team_access | A map of access to the repository | map |
{ |
no |
visibility | (optional) Visibility of the repository. Can be public, private or internal | string |
"public" |
no |
Name | Description |
---|---|
repository | Respository resource |