A collection of modules used to validate GitHub resource configurations in Terraform.
Note: Terraform Checks were released in Terraform 1.5.0. This module requires Terraform 1.5.0 or later.
To validate a GitHub organization's configuration, call the module in your Terraform configuration and specify the configuration options you expect. Checks for variables not explicitly set will assume the settings from GitHub are desirable.
module "validate_github_org_config" {
source = "garnertb/terraform-github-checks"
org_name = "garnertb-io"
advanced_security_enabled_for_new_repositories = false
dependabot_alerts_enabled_for_new_repositories = true
}Follow authentication instructions from the Terraform GitHub Provider to authenticate with the GitHub API.
If you are using a GitHub App to authenticate with the GitHub API, you will need to grant the following permission scopes:
| Permission | Scope | Use |
|---|---|---|
| Administration | read-only |
Used to read the organization's settings. |
| Members | read-only |
Used to read the organization's members. |