Terraform Module: GitHub Repository

This repository is a Terraform Module for managing GitHub Repository and Branch Protection resources.

Requirements
Dependencies
Usage
- Module Variables
Author Information
License

Requirements

This module requires Terraform version 0.10.x or newer.

Dependencies

This module depends on a correctly configured GitHub Provider in your Terraform codebase.

Usage

Add the module to your Terraform resources like so:

module "foo-cli" {
  source                               = "github.com/withmethod/terraform-module-github-repository?ref=0.3.1"
  name                                 = "foo-cli"
  description                          = "foo CLI"
  homepage_url                         = "https://withmethod.com/open-source/"
  private                              = true
  has_issues                           = true
  has_wiki                             = false
  allow_merge_commit                   = false
  allow_squash_merge                   = true
  allow_rebase_merge                   = false
  has_downloads                        = false
  auto_init                            = true
  gitignore_template                   = "Terraform"
  license_template                     = "apache-2.0"
  enable_team_repository               = 1
  team_repository_team                 = "${github_team.internal.id}"
  team_repository_permission           = "pull"
  branch                               = "master"
  enable_branch_protection             = 1 // only works after initial creation of repository
  enforce_admins                       = true
  req_status_checks_strict             = false
  req_status_checks_context            = ["continuous-integration/travis-ci"]
  req_pr_reviews_dismiss_stale_reviews = true
  req_pr_reviews_dismissal_users       = []
  req_pr_reviews_dismissal_teams       = []
  restrictions_users                   = []
  restrictions_teams                   = []
}

Then, load the module using terraform get.

Module Variables

Available variables are listed below, along with their default values:

variable	description
`name`	The name of the repository
`description`	A description of the repository
`homepage_url`	URL of a page describing the project
`private`	Set to `true` to create a private repository
`has_issues`	Set to `true` to enable the GitHub Issues features on the repository
`has_wiki`	Set to `true` to enable the GitHub Wiki features on the repository
`allow_merge_commit`	Set to `false` to disable merge commits on the repository
`allow_squash_merge`	Set to `false` to disable squash merges on the repository
`allow_rebase_merge`	Set to `false` to disable rebase merges on the repository
`has_downloads`	Set to `true` to enable the (deprecated) downloads features on the repository
`auto_init`	Set to `true` to produce an initial commit in the repository
`gitignore_template`	Set to a template to use for the `.gitignore` file
`license_template`	Set to a template to use for the license
`enable_team_repository`	Boolean to toggle team repository settings
`team_repository_team`	The GitHub team ID
`team_repository_permission`	The permissions of team members regarding the repository
`enable_branch_protection`	Boolean to toggle branch protection settings. Only works after repository has been created
`branch`	The name of the default branch of the repository
`enforce_admins`	Boolean to toggle enforcement of status checks for administrators
`req_status_checks_strict`	Boolean to toggle strictness of status checks
`req_status_checks_context`	List of status checks to require in order to merge into this branch
`req_pr_reviews_dismiss_stale_reviews`	Boolean to toggle dismissal of reviews when a new commit is pushed
`req_pr_reviews_dismissal_users`	The list of user logins with dismissal access
`req_pr_reviews_dismissal_teams`	The list of team slugs with dismissal access
`restrictions_users`	The list of user logins with push access
`restrictions_teams`	The list of team slugs with push access

private defaults to true
has_downloads defaults to false
license_template defaults to apache-2.0
branch defaults to master
enforce_admins defaults to true
req_pr_reviews_dismiss_stale_reviews defaults to true

Please note: auto_init, gitignore_template as well as license_template are actions that will result in commits being made to the GitHub Repository. These commits will be attributed to the user that is linked to the token that is used for the GitHub provider.

Module outputs

Available outputs are listed below, along with their description

output	description
`full_name`	A string of the form `orgname/reponame`.
`ssh_clone_url`	URL that can be provided to `git clone` to clone the repository via SSH.
`http_clone_url`	URL that can be provided to `git clone` to clone the repository via HTTPS.
`git_clone_url`	URL that can be provided to git clone to clone the repository anonymously via the git protocol.
`svn_url`	URL that can be provided to `svn checkout` to check out the repository via GitHub's Subversion protocol emulation.

Author Information

This module is currently maintained by the individuals listed below.

Kerim Satirli

Development of this module was sponsored by Method.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

reubenavery/terraform-github-repository