GitHub Pages Terraform module
Terraform module to create Github Repositories that support Github Pages.
NOTE: As of v4.5 of the Github provider, there is no way to enabling enforcement of HTTPS via this module. This needs to be checked manually in the console.
These types of resources are supported:
Terraform versions
Terraform 0.14 and newer. Pin module version to ~> v0.2. Submit pull-requests to main branch.
Usage
module "repository" {
source = "patrick-andrew-jain-taylor/pages/github"
description = "This is an example page."
repository_name = "example"
root_domain = "example.com"
subdomain = "www"
}
Requirements
| Name | Version |
|---|---|
| terraform | >= 0.14.7 |
| github | >= 4.5.0 |
Providers
| Name | Version |
|---|---|
| github | >= 4.5.0 |
Modules
No Modules.
Resources
| Name |
|---|
| github_branch_default |
| github_repository |
| github_repository_file |
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| description | Description of repository. | string |
N/A |
yes |
| repository_name | Name of respository. | string |
N/A |
yes |
| root_domain | Domain name for page (i.e. example.com). | string |
N/A |
yes |
| subdomain | Subdomain name for page (i.e. www.example.com). | string |
N/A |
yes |
Outputs
| Name | Description |
|---|---|
| github_branch_default | Github Branch Default Resource. |
| github_repository | Github Repository Resource. |
| github_repository_file | Github Repository CNAME File Resource. |
| github_user | Currently authenticated user. |
Authors
Module is maintained by Patrick Jain-Taylor with help from these contributors.
License
MIT Licensed. See LICENSE for full details.