https://github.com/garnertb/terraform-github-checks

A collection of modules to validate GitHub resource configurations in Terraform.
https://github.com/garnertb/terraform-github-checks

continuous-validation terraform

Last synced: 22 days ago
JSON representation

A collection of modules to validate GitHub resource configurations in Terraform.

• Host: GitHub
• URL: https://github.com/garnertb/terraform-github-checks
• Owner: garnertb
• Created: 2023-09-12T14:23:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-12T18:55:18.000Z (over 1 year ago)
• Last Synced: 2024-10-26T15:46:08.044Z (2 months ago)
• Topics: continuous-validation, terraform
• Language: HCL
• Homepage:
• Size: 24.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# terraform-github-validation

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.

## Usage

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.

```hcl

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

}

```

## GitHub Authentication and Permissions

### Authenticating

Follow authentication instructions from the [Terraform GitHub Provider](https://registry.terraform.io/providers/integrations/github/latest/docs#authentication) to authenticate with the GitHub API.

### GitHub App

If you are using a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps) 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.  |