feat-initial-version-examples-test-built

Author: andreouellet

.gitignore

@@ -5,6 +5,9 @@
 *.tfstate
 *.tfstate.*
 
+# terraform lock file
+examples/.terraform.lock.hcl
+
 # Crash log files
 crash.log
 

README.md

@@ -19,13 +19,13 @@ Terraform module for creating and managing GitHub Organizations
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
-| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
+| <a name="requirement_github"></a> [github](#requirement\_github) | 5.3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_github"></a> [github](#provider\_github) | n/a |
+| <a name="provider_github"></a> [github](#provider\_github) | 5.3.0 |
 
 ## Modules
 
@@ -35,9 +35,9 @@ No modules.
 
 | Name | Type |
 |------|------|
-| [github_organization_project.this](https://registry.terraform.io/providers/hashicorp/github/latest/docs/resources/organization_project) | resource |
-| [github_organization_settings.this](https://registry.terraform.io/providers/hashicorp/github/latest/docs/resources/organization_settings) | resource |
-| [github_organization_webhook.this](https://registry.terraform.io/providers/hashicorp/github/latest/docs/resources/organization_webhook) | resource |
+| [github_organization_project.this](https://registry.terraform.io/providers/integrations/github/5.3.0/docs/resources/organization_project) | resource |
+| [github_organization_settings.this](https://registry.terraform.io/providers/integrations/github/5.3.0/docs/resources/organization_settings) | resource |
+| [github_organization_webhook.this](https://registry.terraform.io/providers/integrations/github/5.3.0/docs/resources/organization_webhook) | resource |
 
 ## Inputs
 
@@ -57,9 +57,12 @@ No modules.
 | <a name="input_description"></a> [description](#input\_description) | The description for the GitHub Organization. (Optional) | `string` | `""` | no |
 | <a name="input_email"></a> [email](#input\_email) | The email address (example@example.com) for the GitHub Organization. (Optional) | `string` | `""` | no |
 | <a name="input_github_organization_project_body"></a> [github\_organization\_project\_body](#input\_github\_organization\_project\_body) | The body of the project. (Optional) | `string` | `""` | no |
-| <a name="input_github_organization_project_name"></a> [github\_organization\_project\_name](#input\_github\_organization\_project\_name) | The name of the project. (Required) | `string` | n/a | yes |
+| <a name="input_github_organization_project_name"></a> [github\_organization\_project\_name](#input\_github\_organization\_project\_name) | The name of the project. (Required) | `string` | `""` | no |
 | <a name="input_github_organization_webhook_active"></a> [github\_organization\_webhook\_active](#input\_github\_organization\_webhook\_active) | Indicate of the webhook should receive events. (Optional) | `bool` | `true` | no |
-| <a name="input_github_organization_webhook_config"></a> [github\_organization\_webhook\_config](#input\_github\_organization\_webhook\_config) | Map containing the config for this webhook. (Required) | `map(string)` | `{}` | no |
+| <a name="input_github_organization_webhook_config_content_type"></a> [github\_organization\_webhook\_config\_content\_type](#input\_github\_organization\_webhook\_config\_content\_type) | The content type of the webhook. [form\|json] | `string` | `"form"` | no |
+| <a name="input_github_organization_webhook_config_insecure_ssl"></a> [github\_organization\_webhook\_config\_insecure\_ssl](#input\_github\_organization\_webhook\_config\_insecure\_ssl) | Whether to allow insecure\_ssl. | `bool` | `false` | no |
+| <a name="input_github_organization_webhook_config_secret"></a> [github\_organization\_webhook\_config\_secret](#input\_github\_organization\_webhook\_config\_secret) | Secret for the Webhook | `string` | `""` | no |
+| <a name="input_github_organization_webhook_config_url"></a> [github\_organization\_webhook\_config\_url](#input\_github\_organization\_webhook\_config\_url) | The URL of the webhook | `string` | `""` | no |
 | <a name="input_github_organization_webhook_events"></a> [github\_organization\_webhook\_events](#input\_github\_organization\_webhook\_events) | A list of events which should trigger the webhook. (Optional)<br>For list of valid events, visit https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues | `list(any)` | `[]` | no |
 | <a name="input_has_organization_projects"></a> [has\_organization\_projects](#input\_has\_organization\_projects) | Whether or not organization projects are enabled for the GitHub Organization. (Optional) | `bool` | `true` | no |
 | <a name="input_has_repository_projects"></a> [has\_repository\_projects](#input\_has\_repository\_projects) | Whether or not repository projects are enabled for the GitHub Organization. (Optional) | `bool` | `true` | no |

examples/README.md

@@ -34,19 +34,21 @@ No providers.
 
 | Name | Source | Version |
 |------|--------|---------|
-| <a name="module_template_null_resource"></a> [template\_null\_resource](#module\_template\_null\_resource) | ../ | n/a |
+| <a name="module_github_organization_settings"></a> [github\_organization\_settings](#module\_github\_organization\_settings) | ../ | n/a |
 
 ## Resources
 
 No resources.
 
 ## Inputs
 
-No inputs.
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_billing_email"></a> [billing\_email](#input\_billing\_email) | The billing email address for the GitHub Organization. (Required) | `string` | n/a | yes |
+| <a name="input_owner"></a> [owner](#input\_owner) | Target GitHub organization or individual user account to manage. (Required) | `string` | n/a | yes |
+| <a name="input_token"></a> [token](#input\_token) | GitHub API Auth using OAuth or Personal Access Token. (Required) | `string` | n/a | yes |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
-| <a name="output_template_null_resource_id"></a> [template\_null\_resource\_id](#output\_template\_null\_resource\_id) | The ID of the null resource |
+No outputs.
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/deploy.tf

@@ -1,5 +1,7 @@
 provider "github" {
-  owner = "dsodk-test"
+
+  owner = var.owner
+  token = var.token
 
   #token    = var.github_token    # GITHUB_TOKEN    - GitHub API Auth using OAuth or Personal Access Token
   #base_url = var.github_base_url # GITHUB_BASE_URL - Target GitHub base API endpoint. Required for GitHub Enterprise
@@ -10,14 +12,30 @@ provider "github" {
 }
 
 ##################################################
-# Null Resource Module
+# GitHub Organization
 ##################################################
 
-module "template_null_resource" {
+module "github_organization_settings" {
   source = "../"
 
-  triggers = {
-    name    = "dsodk-template-code-terraform-module"
-    trigger = "Change this text to trigger the module to replace null resources with new ones"
-  }
+  billing_email = var.billing_email
+  company       = "dsodk"
+  email         = "terraform.module.test@dsodk.io"
+  location      = "Global"
+  name          = "dsodk-test-github-org-module"
+  description   = "Test organization used by example in dsodk-code-module-terraform-github-organization"
+
+  default_repository_permission = "read"
+
+  members_can_create_repositories         = false
+  members_can_create_public_repositories  = false
+  members_can_create_private_repositories = false
+
+  members_can_create_pages              = false
+  members_can_create_public_pages       = false
+  members_can_create_private_pages      = false
+  members_can_fork_private_repositories = false
+
+  secret_scanning_enabled_for_new_repositories                 = true
+  secret_scanning_push_protection_enabled_for_new_repositories = true
 }

examples/outputs.tf

@@ -1,4 +0,0 @@
-output "template_null_resource_id" {
-  description = "The ID of the null resource"
-  value       = module.template_null_resource.template_null_resource_id
-}

examples/variables.tf

@@ -0,0 +1,24 @@
+##################################################
+# GitHub Provider Config
+##################################################
+
+variable "owner" {
+  description = "Target GitHub organization or individual user account to manage. (Required)"
+  type        = string
+}
+
+variable "token" {
+  description = "GitHub API Auth using OAuth or Personal Access Token. (Required)"
+  type        = string
+  sensitive   = true
+}
+
+##################################################
+# GitHub Organization
+##################################################
+
+variable "billing_email" {
+  description = "The billing email address for the GitHub Organization. (Required)"
+  type        = string
+  sensitive   = true
+}

main.tf

@@ -53,9 +53,14 @@ resource "github_organization_project" "this" {
 resource "github_organization_webhook" "this" {
   count = var.create_github_organization && var.create_github_organization_webhook ? 1 : 0
 
-  events        = var.github_organization_webhook_events
-  configuration = var.github_organization_webhook_config
+  events = var.github_organization_webhook_events
+
+  configuration {
+    url          = var.github_organization_webhook_config_url
+    content_type = var.github_organization_webhook_config_content_type
+    insecure_ssl = var.github_organization_webhook_config_insecure_ssl
+    secret       = var.github_organization_webhook_config_secret
+  }
 
   active = var.github_organization_webhook_active
-  name   = "web" # This is the type of hook. "web" is the default and only option.
 }

variables.tf

@@ -176,6 +176,7 @@ variable "create_github_organization_project" {
 variable "github_organization_project_name" {
   description = "The name of the project. (Required)"
   type        = string
+  default     = ""
 }
 
 variable "github_organization_project_body" {
@@ -194,16 +195,41 @@ variable "create_github_organization_webhook" {
   default     = false
 }
 
-variable "github_organization_webhook_config" {
-  description = "Map containing the config for this webhook. (Required)"
-  type        = map(string)
-  default     = {}
-  #type = object({
-  #  url = (string),
-  #  content_type = (string, form),  # [form|json]
-  #  insecure_ssl = (bool, false)
-  #  secret       = optional(string)
-  #})
+#variable "github_organization_webhook_config" {
+#  description = "Map containing the config for this webhook. (Required)"
+#  type        = map(string)
+#  default     = {}
+#  #type = object({
+#  #  url = (string),
+#  #  content_type = (string, form),  # [form|json]
+#  #  insecure_ssl = (bool, false)
+#  #  secret       = optional(string)
+#  #})
+#}
+
+variable "github_organization_webhook_config_url" {
+  description = "The URL of the webhook"
+  type        = string
+  default     = ""
+}
+
+variable "github_organization_webhook_config_content_type" {
+  description = "The content type of the webhook. [form|json]"
+  type        = string
+  default     = "form"
+}
+
+variable "github_organization_webhook_config_insecure_ssl" {
+  description = "Whether to allow insecure_ssl."
+  type        = bool
+  default     = false
+}
+
+variable "github_organization_webhook_config_secret" {
+  description = "Secret for the Webhook"
+  type        = string
+  default     = ""
+  sensitive   = true
 }
 
 variable "github_organization_webhook_active" {

versions.tf

@@ -2,13 +2,9 @@ terraform {
   required_version = ">= 1.0"
 
   required_providers {
-    #    aws = {
-    #      source  = "hashicorp/aws"
-    #      version = ">= 4.0"
-    #    },
-    null = {
-      source  = "hashicorp/null"
-      version = ">= 3.0"
+    github = {
+      source  = "integrations/github"
+      version = "5.3.0"
     }
   }
 }