Skip to content

Standard OPG GitHub Repository Module: Managed by opg-org-infra & Terraform

License

Notifications You must be signed in to change notification settings

ministryofjustice/opg-terraform-github-repository

Repository files navigation

Requirements

Name Version
terraform >= 1.0.0
github ~> 5.0

Providers

Name Version
github 5.32.0

Modules

No modules.

Resources

Name Type
github_actions_secret.repository_secret resource
github_branch_default.default resource
github_branch_protection.repository_main resource
github_repository.repository resource
github_team_repository.admin_team_access resource
github_team_repository.developer_access resource
github_team_repository.opg_access resource
github_team.opg data source
github_team.webops data source

Inputs

Name Description Type Default Required
admin_team_only Disable developer team for this repository bool false no
allow_auto_merge Allow auto-merging on pull-requests bool false no
allow_merge_commit Allow Merge Commits, defualts to true bool true no
allow_rebase_merge Allow Rebase Commits, defualts to true bool true no
allow_squash_merge Allow Squash Commits, defualts to true bool true no
archived Archives the repository if set to true bool false no
auto_init Meaningful only during create; set to true to produce an initial commit in the repository. bool true no
branch_protection_enabled Boolean, setting this to false will disable branch protection bool true no
default_branch_name Default branch name and the branch name with protection applied to it string "main" no
delete_branch_on_merge Automatically delete head branch after a pull request is merged. bool false no
description Repository description. Leave blank for default of: Development repository string "Development repository" no
developer_team Team ID that developers belong to string "" no
dismiss_stale_reviews Dismiss approved reviews automatically when a new commit is pushed. Defaults to true. bool true no
enforce_admins Boolean, setting this to true enforces status checks for repository administrators bool true no
github_secrets A map of secrets to pass to GitHub map(any) {} no
has_issues Turns on/off github issues bool true no
has_projects Turns on/off github projects bool false no
has_wiki Turns on/off the github wiki bool false no
homepage_url Home page URL for the Git repo string "" no
is_template Define as a template repository bool false no
name Name of the repository string n/a yes
pages The repository's GitHub Pages configuration. (Default: {}) any null no
require_ci_pass Require all CI checks listed in status_checks to pass bool true no
require_code_owner_reviews Require an approved review in pull requests including files with a designated code owner. Defaults to true bool false no
required_approving_review_count Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. Defaults to 1 number 1 no
status_checks A list of required passing CI checks. list(any) [] no
template Template repository to use. (Default: {})
object({
owner = string
repository = string
})
null no
topics A list of topics. list(any) [] no
visibility Visibility of the repository. string "private" no
vulnerability_alerts Enable security alerts for vulnerable dependencies. Defaults to True bool true no

Outputs

Name Description
git_clone_url n/a
name n/a

About

Standard OPG GitHub Repository Module: Managed by opg-org-infra & Terraform

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Languages