feat!: add support for configuring default squash and merge commit title and messages (#3)

* docs: add missing default options to README.md

* chore: prepare v0.18.0 release

---------

Co-authored-by: Soren Martius <soeren.martius@gmail.com>
Co-authored-by: Marius Tolzmann <marius@mineiros.io>

Author: 3 people

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.19.0]
+
+### Changed
+
+- BREAKING: update to provider `>= 4.31` for supporting default squash and merge commit titles and messages
+
+### Added
+
+- Add support for `squash_merge_commit_title`
+- Add support for `squash_merge_commit_message`
+- Add support for `merge_commit_title`
+- Add support for `merge_commit_message`
+
 ## [0.18.0]
 
 ### Added
@@ -399,7 +412,8 @@ 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.
 
-[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.18.0...HEAD
+[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.19.0...HEAD
+[0.19.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.18.0...v0.19.0
 [0.18.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.17.0...v0.18.0
 [0.17.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.2...v0.17.0
 [0.16.2]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.1...v0.16.2

README.md

@@ -3,18 +3,18 @@
 [![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-4.31+-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
 
 A [Terraform] module for creating a public or private repository on [Github].
 
-**_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.20 and above from `integrations/github`._**
+**_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.31 and above from `integrations/github`._**
 
 **Attention: This module is incompatible with the Hashicorp GitHub Provider! The latest version of this module supporting `hashicorp/github` provider is `~> 0.10.0`**
 
-** Note: Versions 5.3.0, 5.4.0, and 5.5.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
+** Note: Versions 5.3.0, 5.4.0, 5.5.0, and 5.6.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
 
 
 - [GitHub as Code](#github-as-code)
@@ -90,7 +90,8 @@ features like Branch Protection or Collaborator Management.
   Teams,
   Deploy Keys,
   Projects,
-  Repository Webhooks
+  Repository Webhooks,
+  GitHub App Installations
 
 - _Features not yet implemented_:
   Project Columns support,
@@ -182,6 +183,30 @@ See [variables.tf] and [examples/] for details and use-cases.
 
   Default is `false`.
 
+- [**`squash_merge_commit_title`**](#var-squash_merge_commit_title): *(Optional `string`)*<a name="var-squash_merge_commit_title"></a>
+
+  Set to `PR_TITLE` or `COMMIT_OR_PR_TITLE` for a default squash merge commit title.
+
+  Default is `"COMMIT_OR_PR_TITLE"`.
+
+- [**`squash_merge_commit_message`**](#var-squash_merge_commit_message): *(Optional `string`)*<a name="var-squash_merge_commit_message"></a>
+
+  Set to `PR_BODY`, `COMMIT_MESSAGES`, or `BLANK` for a default squash merge commit message.
+
+  Default is `"COMMIT_MESSAGES"`.
+
+- [**`merge_commit_title`**](#var-merge_commit_title): *(Optional `string`)*<a name="var-merge_commit_title"></a>
+
+  Set to `PR_TITLE` or `MERGE_MESSAGE` for a default merge commit title.
+
+  Default is `"MERGE_MESSAGE"`.
+
+- [**`merge_commit_message`**](#var-merge_commit_message): *(Optional `string`)*<a name="var-merge_commit_message"></a>
+
+  Set to `PR_BODY`, `PR_TITLE`, or `BLANK` for a default merge commit message.
+
+  Default is `"PR_TITLE"`.
+
 - [**`description`**](#var-description): *(Optional `string`)*<a name="var-description"></a>
 
   A description of the repository.

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-4.31+-F8991D.svg?logo=terraform"
     url   = "https://github.com/terraform-providers/terraform-provider-github/releases"
     text  = "Github Provider Version"
   }
@@ -39,11 +39,11 @@ section {
   content = <<-END
     A [Terraform] module for creating a public or private repository on [Github].
 
-    **_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.20 and above from `integrations/github`._**
+    **_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.31 and above from `integrations/github`._**
 
     **Attention: This module is incompatible with the Hashicorp GitHub Provider! The latest version of this module supporting `hashicorp/github` provider is `~> 0.10.0`**
 
-    ** Note: Versions 5.3.0, 5.4.0, and 5.5.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
+    ** Note: Versions 5.3.0, 5.4.0, 5.5.0, and 5.6.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
   END
 
   section {
@@ -92,7 +92,8 @@ section {
         Teams,
         Deploy Keys,
         Projects,
-        Repository Webhooks
+        Repository Webhooks,
+        GitHub App Installations
 
       - _Features not yet implemented_:
         Project Columns support,
@@ -216,6 +217,38 @@ section {
         END
       }
 
+      variable "squash_merge_commit_title" {
+        type        = string
+        default     = "COMMIT_OR_PR_TITLE"
+        description = <<-END
+          Set to `PR_TITLE` or `COMMIT_OR_PR_TITLE` for a default squash merge commit title.
+        END
+      }
+
+      variable "squash_merge_commit_message" {
+        type        = string
+        default     = "COMMIT_MESSAGES"
+        description = <<-END
+          Set to `PR_BODY`, `COMMIT_MESSAGES`, or `BLANK` for a default squash merge commit message.
+        END
+      }
+
+      variable "merge_commit_title" {
+        type        = string
+        default     = "MERGE_MESSAGE"
+        description = <<-END
+          Set to `PR_TITLE` or `MERGE_MESSAGE` for a default merge commit title.
+        END
+      }
+
+      variable "merge_commit_message" {
+        type        = string
+        default     = "PR_TITLE"
+        description = <<-END
+          Set to `PR_BODY`, `PR_TITLE`, or `BLANK` for a default merge commit message.
+        END
+      }
+
       variable "description" {
         type        = string
         default     = ""

examples/public-repository/README.md

@@ -15,7 +15,7 @@ branch protection.
 ```hcl
 module "repository" {
   source  = "mineiros-io/repository/github"
-  version = "~> 0.13.0"
+  version = "~> 0.18.0"
 
   module_depends_on = [
     github_team.team

main.tf

@@ -11,14 +11,14 @@ locals {
   visibility             = var.visibility == null ? lookup(var.defaults, "visibility", local.private_visibility) : var.visibility
   has_issues             = var.has_issues == null ? lookup(var.defaults, "has_issues", false) : var.has_issues
   has_projects           = var.has_projects == null ? lookup(var.defaults, "has_projects", false) : length(var.projects) > 0 ? true : var.has_projects
+  has_downloads          = var.has_downloads == null ? lookup(var.defaults, "has_downloads", false) : var.has_downloads
   has_wiki               = var.has_wiki == null ? lookup(var.defaults, "has_wiki", false) : var.has_wiki
   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
   auto_init              = var.auto_init == null ? lookup(var.defaults, "auto_init", true) : var.auto_init
   gitignore_template     = var.gitignore_template == null ? lookup(var.defaults, "gitignore_template", "") : var.gitignore_template
   license_template       = var.license_template == null ? lookup(var.defaults, "license_template", "") : var.license_template
@@ -28,6 +28,11 @@ locals {
   template               = var.template == null ? [] : [var.template]
   issue_labels_create    = var.issue_labels_create == null ? lookup(var.defaults, "issue_labels_create", local.issue_labels_create_computed) : var.issue_labels_create
 
+  squash_merge_commit_title   = var.squash_merge_commit_title == null ? try(var.defaults.squash_merge_commit_title, "COMMIT_OR_PR_TITLE") : var.squash_merge_commit_title
+  squash_merge_commit_message = var.squash_merge_commit_message == null ? try(var.defaults.squash_merge_commit_message, "COMMIT_MESSAGES") : var.squash_merge_commit_message
+  merge_commit_title          = var.merge_commit_title == null ? try(var.defaults.merge_commit_title, "MERGE_MESSAGE") : var.merge_commit_title
+  merge_commit_message        = var.merge_commit_message == null ? try(var.merge_commit_message, "PR_TITLE") : var.merge_commit_message
+
   issue_labels_create_computed = local.has_issues || length(var.issue_labels) > 0
 
   # for readability
@@ -112,6 +117,11 @@ resource "github_repository" "repository" {
   archive_on_destroy   = var.archive_on_destroy
   vulnerability_alerts = local.vulnerability_alerts
 
+  squash_merge_commit_title   = local.squash_merge_commit_title
+  squash_merge_commit_message = local.squash_merge_commit_message
+  merge_commit_title          = local.merge_commit_title
+  merge_commit_message        = local.merge_commit_message
+
   dynamic "template" {
     for_each = local.template
 

test/unit-complete/provider.tf

@@ -5,7 +5,9 @@ terraform {
 
   required_providers {
     github = {
-      source = "integrations/github"
+      source  = "integrations/github"
+      version = "~> 5.0, !=5.3.0, !=5.4.0, !=5.5.0, !=5.6.0, !=5.7.0"
+      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"
     }

test/unit-complete/variables.tf

@@ -70,7 +70,6 @@ variable "allow_auto_merge" {
   default     = true
 }
 
-
 variable "has_downloads" {
   description = "Set to true to enable the (deprecated) downloads features on the repository."
   type        = bool
@@ -156,6 +155,7 @@ variable "repository_defaults" {
     homepage_url       = "https://github.com/mineiros-io"
     visibility         = "private"
     allow_merge_commit = true
+    allow_squash_merge = false
     gitignore_template = "Terraform"
     license_template   = "mit"
     topics             = ["terraform", "integration-test"]

variables.tf

@@ -556,6 +556,30 @@ variable "app_installations" {
   default     = []
 }
 
+variable "squash_merge_commit_title" {
+  type        = string
+  description = "(Optional) Can be `PR_BODY`, `COMMIT_MESSAGES`, or `BLANK` for a default squash merge commit message."
+  default     = "COMMIT_OR_PR_TITLE"
+}
+
+variable "squash_merge_commit_message" {
+  type        = string
+  description = "(Optional) Can be `PR_BODY`, `COMMIT_MESSAGES`, or `BLANK` for a default squash merge commit message."
+  default     = "COMMIT_MESSAGES"
+}
+
+variable "merge_commit_title" {
+  type        = string
+  description = "(Optional) Can be `PR_TITLE` or `MERGE_MESSAGE` for a default merge commit title."
+  default     = "MERGE_MESSAGE"
+}
+
+variable "merge_commit_message" {
+  type        = string
+  description = "(Optional) Can be `PR_BODY`, `PR_TITLE`, or `BLANK` for a default merge commit message."
+  default     = "PR_TITLE"
+}
+
 # ------------------------------------------------------------------------------
 # MODULE CONFIGURATION PARAMETERS
 # These variables are used to configure the module.

versions.tf

@@ -9,7 +9,7 @@ terraform {
   required_providers {
     github = {
       source  = "integrations/github"
-      version = ">= 4.20, < 6.0"
+      version = ">= 4.31, < 6.0"
     }
   }
 }