Merge pull request #94 from mineiros-io/soerenmartius/auto-merge

Add support for allow_auto_merge

Author: mariux

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.0]
+
+### BREAKING CHANGES
+
+Bumped the minimum supported version of the GitHub Terraform Provider to `v4.19.2`
+since it contains a critical bugfix to support `required_approving_review_count = 0`
+on branch protection rules. Also, `allow_auto_merge` has been added in `v4.17.0`.
+
+### Added
+
+- Add support for `allow_auto_merge`
+
 ## [0.11.0]
 
 ### BREAKING CHANGES
@@ -322,13 +334,9 @@ Please review plans and report regressions and issues asap so we can improve doc
 - This is the initial release of our GitHub Repository module with support for
   creating and managing GitHub Repositories for Organizations.
 
-<!-- markdown-link-check-disable -->
-
-[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.11.0...HEAD
+[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.11.0...v0.12.0
 [0.11.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.1...v0.11.0
-
-<!-- markdown-link-check-enable -->
-
 [0.10.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.0...v0.10.1
 [0.10.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.9.2...v0.10.0
 [0.9.2]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.9.1...v0.9.2

README.md

@@ -129,6 +129,7 @@ See [variables.tf] and [examples/] for details and use-cases.
   `allow_merge_commit`,
   `allow_rebase_merge`,
   `allow_squash_merge`,
+  `allow_auto_merge`,
   `has_downloads`,
   `auto_init`,
   `gitignore_template`,
@@ -185,6 +186,15 @@ See [variables.tf] and [examples/] for details and use-cases.
 
   Default is `false`.
 
+- [**`allow_auto_merge`**](#var-allow_auto_merge): *(Optional `bool`)*<a name="var-allow_auto_merge"></a>
+
+  Set to `true`  to allow [auto-merging](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)
+  pull requests on the repository. If you enable auto-merge for a pull
+  request, the pull request will merge automatically when all required
+  reviews are met and status checks have passed.
+
+  Default is `false`.
+
 - [**`description`**](#var-description): *(Optional `string`)*<a name="var-description"></a>
 
   A description of the repository.

README.tfdoc.hcl

@@ -147,6 +147,7 @@ section {
           `allow_merge_commit`,
           `allow_rebase_merge`,
           `allow_squash_merge`,
+          `allow_auto_merge`,
           `has_downloads`,
           `auto_init`,
           `gitignore_template`,
@@ -219,6 +220,17 @@ section {
         END
       }
 
+      variable "allow_auto_merge" {
+        type        = bool
+        default     = false
+        description = <<-END
+          Set to `true`  to allow [auto-merging](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)
+          pull requests on the repository. If you enable auto-merge for a pull
+          request, the pull request will merge automatically when all required
+          reviews are met and status checks have passed.
+        END
+      }
+
       variable "description" {
         type        = string
         default     = ""

examples/public-repository/README.md

@@ -108,12 +108,7 @@ Run `terraform destroy` to destroy all resources again.
 
 <!-- References -->
 
-<!-- markdown-link-check-disable -->
-
 [main.tf]: https://github.com/mineiros-io/terraform-github-repository/blob/main/examples/public-respository/main.tf
-
-<!-- markdown-link-check-enable -->
-
 [homepage]: https://mineiros.io/?ref=terraform-github-repository
 [badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
 [badge-terraform]: https://img.shields.io/badge/terraform-1.x%20|0.15%20|0.14%20|%200.13%20|%200.12.20+-623CE4.svg?logo=terraform

examples/public-repository/main.tf

@@ -23,6 +23,7 @@ module "repository" {
   allow_merge_commit = true
   allow_rebase_merge = false
   allow_squash_merge = false
+  allow_auto_merge   = true
   has_downloads      = false
   auto_init          = true
   gitignore_template = "Terraform"

main.tf

@@ -15,6 +15,7 @@ locals {
   allow_merge_commit     = var.allow_merge_commit == null ? lookup(var.defaults, "allow_merge_commit", true) : var.allow_merge_commit
   allow_rebase_merge     = var.allow_rebase_merge == null ? lookup(var.defaults, "allow_rebase_merge", false) : var.allow_rebase_merge
   allow_squash_merge     = var.allow_squash_merge == null ? lookup(var.defaults, "allow_squash_merge", false) : var.allow_squash_merge
+  allow_auto_merge       = var.allow_auto_merge == null ? lookup(var.defaults, "allow_auto_merge", false) : var.allow_auto_merge
   delete_branch_on_merge = var.delete_branch_on_merge == null ? lookup(var.defaults, "delete_branch_on_merge", true) : var.delete_branch_on_merge
   is_template            = var.is_template == null ? lookup(var.defaults, "is_template", false) : var.is_template
   has_downloads          = var.has_downloads == null ? lookup(var.defaults, "has_downloads", false) : var.has_downloads

test/unit-complete/main.tf

@@ -39,6 +39,7 @@ module "repository" {
   allow_merge_commit     = var.allow_merge_commit
   allow_rebase_merge     = var.allow_rebase_merge
   allow_squash_merge     = var.allow_squash_merge
+  allow_auto_merge       = var.allow_auto_merge
   delete_branch_on_merge = var.delete_branch_on_merge
   is_template            = var.is_template
   has_downloads          = var.has_downloads

test/unit-complete/provider.tf

@@ -6,7 +6,7 @@ terraform {
   required_providers {
     github = {
       source  = "integrations/github"
-      version = "~> 4.10"
+      version = "~> 4.19"
     }
     tls = "~> 2.1"
   }

test/unit-complete/variables.tf

@@ -64,6 +64,13 @@ variable "allow_rebase_merge" {
   default     = true
 }
 
+variable "allow_auto_merge" {
+  description = "Set to true to allow auto-merging pull requests on the repository."
+  type        = bool
+  default     = true
+}
+
+
 variable "has_downloads" {
   description = "Set to true to enable the (deprecated) downloads features on the repository."
   type        = bool

variables.tf

@@ -28,6 +28,7 @@ variable "defaults" {
   #   allow_merge_commit     = true
   #   allow_rebase_merge     = false
   #   allow_squash_merge     = false
+  #   allow_auto_merge       = false
   #   has_downloads          = false
   #   auto_init              = true
   #   gitignore_template     = "terraform"
@@ -99,6 +100,12 @@ variable "allow_rebase_merge" {
   default     = null
 }
 
+variable "allow_auto_merge" {
+  description = "(Optional) Set to true to allow auto-merging pull requests on the repository. If enabled for a pull request, the pull request will merge automatically when all required reviews are met and status checks have passed. (Default: false)"
+  type        = bool
+  default     = null
+}
+
 variable "delete_branch_on_merge" {
   description = "(Optional) Whether or not to delete the merged branch after merging a pull request. (Default: false)"
   type        = bool