feat!: Add support for allow_update_branch

soerenmartius · soerenmartius · commit f7aaf4656bf2 · 2023-02-02T16:49:35.000+04:00
diff --git a/.tflint.hcl b/.tflint.hcl
@@ -0,0 +1,7 @@
+rule "terraform_unused_declarations" {
+  enabled = false
+}
+
+rule "terraform_required_providers" {
+  enabled = false
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add support for `allow_update_branch`.
+
+### Changed
+
+- BREAKING CHANGE: Bump minimum supported version of the GitHub provider to `v5.16`
+  as it contains a [critical fix](https://github.com/integrations/terraform-provider-github/pull/1415) for branch protections.
+
 ## [0.18.0]
 
 ### Added
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Build Status](https://github.com/mineiros-io/terraform-github-repository/workflows/CI/CD%20Pipeline/badge.svg)](https://github.com/mineiros-io/terraform-github-repository/actions)
 [![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/mineiros-io/terraform-github-repository.svg?label=latest&sort=semver)](https://github.com/mineiros-io/terraform-github-repository/releases)
 [![Terraform Version](https://img.shields.io/badge/terraform-1.x-623CE4.svg?logo=terraform)](https://github.com/hashicorp/terraform/releases)
-[![Github Provider Version](https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform)](https://github.com/terraform-providers/terraform-provider-github/releases)
+[![Github Provider Version](https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform)](https://github.com/terraform-providers/terraform-provider-github/releases)
 [![Join Slack](https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack)](https://join.slack.com/t/mineiros-community/shared_invite/zt-ehidestg-aLGoIENLVs6tvwJ11w9WGg)
 
 # terraform-github-repository
@@ -649,6 +649,12 @@ This is due to some terraform limitation and we will update the module once terr
 
     Default is `false`.
 
+  - [**`allow_update_branch`**](#attr-branch_protections_v4-allow_update_branch): *(Optional `bool`)*<a name="attr-branch_protections_v4-allow_update_branch"></a>
+
+    Set to `true` to always suggest updating pull request branches.
+
+    Default is `false`.
+
   - [**`blocks_creations`**](#attr-branch_protections_v4-blocks_creations): *(Optional `bool`)*<a name="attr-branch_protections_v4-blocks_creations"></a>
 
     Setting this to `true` will block creating the branch.
@@ -1078,7 +1084,7 @@ Run `make help` to see details on each available target.
 This module is licensed under the Apache License Version 2.0, January 2004.
 Please see [LICENSE] for full details.
 
-Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
+Copyright &copy; 2020-2023 [Mineiros GmbH][homepage]
 
 
 <!-- References -->
@@ -1097,7 +1103,7 @@ Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
 [badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
 [badge-terraform]: https://img.shields.io/badge/terraform-1.x-623CE4.svg?logo=terraform
 [badge-slack]: https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack
-[badge-tf-gh]: https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform
+[badge-tf-gh]: https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform
 [releases-github-provider]: https://github.com/terraform-providers/terraform-provider-github/releases
 [build-status]: https://github.com/mineiros-io/terraform-github-repository/actions
 [releases-github]: https://github.com/mineiros-io/terraform-github-repository/releases
diff --git a/README.tfdoc.hcl b/README.tfdoc.hcl
@@ -21,7 +21,7 @@ header {
   }
 
   badge "tf-gh" {
-    image = "https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform"
+    image = "https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform"
     url   = "https://github.com/terraform-providers/terraform-provider-github/releases"
     text  = "Github Provider Version"
   }
@@ -837,6 +837,14 @@ section {
             END
           }
 
+          attribute "allow_update_branch" {
+            type        = bool
+            default     = false
+            description = <<-END
+              Set to `true` to always suggest updating pull request branches.
+            END
+          }
+
           attribute "blocks_creations" {
             type        = bool
             default     = false
@@ -1442,7 +1450,7 @@ section {
       This module is licensed under the Apache License Version 2.0, January 2004.
       Please see [LICENSE] for full details.
 
-      Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
+      Copyright &copy; 2020-2023 [Mineiros GmbH][homepage]
     END
   }
 }
@@ -1491,7 +1499,7 @@ references {
     value = "https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack"
   }
   ref "badge-tf-gh" {
-    value = "https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform"
+    value = "https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform"
   }
   ref "releases-github-provider" {
     value = "https://github.com/terraform-providers/terraform-provider-github/releases"
diff --git a/examples/public-repository/README.md b/examples/public-repository/README.md
@@ -111,7 +111,7 @@ Run `terraform destroy` to destroy all resources again.
 [main.tf]: https://github.com/mineiros-io/terraform-github-repository/blob/main/examples/public-respository/main.tf
 [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
+[badge-terraform]: https://img.shields.io/badge/terraform-1.x-623CE4.svg?logo=terraform
 [badge-slack]: https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack
 [releases-terraform]: https://github.com/hashicorp/terraform/releases
 [apache20]: https://opensource.org/licenses/Apache-2.0
diff --git a/examples/public-repository/main.tf b/examples/public-repository/main.tf
@@ -13,22 +13,23 @@ module "repository" {
     module.team
   ]
 
-  name               = "my-public-repository"
-  description        = "A description of the repository."
-  homepage_url       = "https://github.com/mineiros-io"
-  visibility         = "public"
-  has_issues         = true
-  has_projects       = false
-  has_wiki           = true
-  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"
-  license_template   = "mit"
-  topics             = ["terraform", "unit-test"]
+  name                = "my-public-repository"
+  description         = "A description of the repository."
+  homepage_url        = "https://github.com/mineiros-io"
+  visibility          = "public"
+  has_issues          = true
+  has_projects        = false
+  has_wiki            = true
+  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"
+  license_template    = "mit"
+  topics              = ["terraform", "unit-test"]
+  allow_update_branch = true
 
   admin_team_ids = [
     module.team.team.id
diff --git a/main.tf b/main.tf
@@ -108,6 +108,7 @@ resource "github_repository" "repository" {
   license_template       = local.license_template
   archived               = var.archived
   topics                 = local.topics
+  allow_update_branch    = var.allow_update_branch
 
   archive_on_destroy   = var.archive_on_destroy
   vulnerability_alerts = local.vulnerability_alerts
diff --git a/test/unit-complete/main.tf b/test/unit-complete/main.tf
@@ -40,6 +40,7 @@ module "repository" {
   allow_rebase_merge     = var.allow_rebase_merge
   allow_squash_merge     = var.allow_squash_merge
   allow_auto_merge       = var.allow_auto_merge
+  allow_update_branch    = true
   delete_branch_on_merge = var.delete_branch_on_merge
   is_template            = var.is_template
   has_downloads          = var.has_downloads
diff --git a/test/unit-complete/provider.tf b/test/unit-complete/provider.tf
@@ -6,8 +6,6 @@ terraform {
   required_providers {
     github = {
       source = "integrations/github"
-      # mask providers with broken branch protection v3 imlementation
-      version = "~> 5.0, !=5.3.0, !=5.4.0, !=5.5.0, !=5.6.0, !=5.7.0"
     }
     tls = {
       source  = "hashicorp/tls"
diff --git a/variables.tf b/variables.tf
@@ -96,6 +96,12 @@ variable "allow_auto_merge" {
   default     = null
 }
 
+variable "allow_update_branch" {
+  description = "(Optional) Set to true to always suggest updating pull request branches."
+  type        = bool
+  default     = false
+}
+
 variable "delete_branch_on_merge" {
   description = "(Optional) Whether or not to delete the merged branch after merging a pull request. (Default: false)"
   type        = bool
diff --git a/versions.tf b/versions.tf
@@ -5,11 +5,10 @@
 terraform {
   required_version = "~> 1.0"
 
-  # branch_protections_v3 are broken in >= 5.3
   required_providers {
     github = {
       source  = "integrations/github"
-      version = ">= 4.20, < 6.0"
+      version = ">= 5.16, < 6.0"
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ header {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`badge "tf-gh" {`
`24`		`- image = "https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform"`
	`24`	`+ image = "https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform"`
`25`	`25`	`url = "https://github.com/terraform-providers/terraform-provider-github/releases"`
`26`	`26`	`text = "Github Provider Version"`
`27`	`27`	`}`
`@@ -837,6 +837,14 @@ section {`
`837`	`837`	`END`
`838`	`838`	`}`
`839`	`839`
	`840`	`+ attribute "allow_update_branch" {`
	`841`	`+ type = bool`
	`842`	`+ default = false`
	`843`	`+ description = <<-END`
	`844`	+ Set to `true` to always suggest updating pull request branches.
	`845`	`+ END`
	`846`	`+ }`
	`847`	`+`
`840`	`848`	`attribute "blocks_creations" {`
`841`	`849`	`type = bool`
`842`	`850`	`default = false`
`@@ -1442,7 +1450,7 @@ section {`
`1442`	`1450`	`This module is licensed under the Apache License Version 2.0, January 2004.`
`1443`	`1451`	`Please see [LICENSE] for full details.`
`1444`	`1452`
`1445`		`- Copyright © 2020-2022 [Mineiros GmbH][homepage]`
	`1453`	`+ Copyright © 2020-2023 [Mineiros GmbH][homepage]`
`1446`	`1454`	`END`
`1447`	`1455`	`}`
`1448`	`1456`	`}`
`@@ -1491,7 +1499,7 @@ references {`
`1491`	`1499`	`value = "https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack"`
`1492`	`1500`	`}`
`1493`	`1501`	`ref "badge-tf-gh" {`
`1494`		`- value = "https://img.shields.io/badge/GH-4.10+-F8991D.svg?logo=terraform"`
	`1502`	`+ value = "https://img.shields.io/badge/GH-5.16+-F8991D.svg?logo=terraform"`
`1495`	`1503`	`}`
`1496`	`1504`	`ref "releases-github-provider" {`
`1497`	`1505`	`value = "https://github.com/terraform-providers/terraform-provider-github/releases"`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,6 @@ terraform {`
`6`	`6`	`required_providers {`
`7`	`7`	`github = {`
`8`	`8`	`source = "integrations/github"`
`9`		`- # mask providers with broken branch protection v3 imlementation`
`10`		`- version = "~> 5.0, !=5.3.0, !=5.4.0, !=5.5.0, !=5.6.0, !=5.7.0"`
`11`	`9`	`}`
`12`	`10`	`tls = {`
`13`	`11`	`source = "hashicorp/tls"`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,10 @@`
`5`	`5`	`terraform {`
`6`	`6`	`required_version = "~> 1.0"`
`7`	`7`
`8`		`- # branch_protections_v3 are broken in >= 5.3`
`9`	`8`	`required_providers {`
`10`	`9`	`github = {`
`11`	`10`	`source = "integrations/github"`
`12`		`- version = ">= 4.20, < 6.0"`
	`11`	`+ version = ">= 5.16, < 6.0"`
`13`	`12`	`}`
`14`	`13`	`}`
`15`	`14`	`}`