Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Squash merge commit message/title #68

Merged
merged 2 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ No modules.
| <a name="input_maintainers"></a> [maintainers](#input\_maintainers) | A list of GitHub teams that should have maintain access | `list(string)` | `[]` | no |
| <a name="input_readers"></a> [readers](#input\_readers) | A list of GitHub teams that should have read access | `list(string)` | `[]` | no |
| <a name="input_repository_files"></a> [repository\_files](#input\_repository\_files) | A list of GitHub repository files that should be created | <pre>map(object({<br> branch = optional(string)<br> path = string<br> content = string<br> }))</pre> | `{}` | no |
| <a name="input_squash_merge_commit_message"></a> [squash\_merge\_commit\_message](#input\_squash\_merge\_commit\_message) | The default commit message for squash merges | `string` | `"COMMIT_MESSAGES"` | no |
| <a name="input_squash_merge_commit_title"></a> [squash\_merge\_commit\_title](#input\_squash\_merge\_commit\_title) | The default commit title for squash merges | `string` | `"COMMIT_OR_PR_TITLE"` | no |
| <a name="input_tag_protection"></a> [tag\_protection](#input\_tag\_protection) | The repository tag protection pattern | `string` | `null` | no |
| <a name="input_template_repository"></a> [template\_repository](#input\_template\_repository) | The settings of the template repostitory to use on creation | <pre>object({<br> owner = string<br> repository = string<br> })</pre> | `null` | no |
| <a name="input_visibility"></a> [visibility](#input\_visibility) | Set the GitHub repository as public, private or internal | `string` | `"private"` | no |
Expand Down
36 changes: 19 additions & 17 deletions main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,25 @@ locals {

#tfsec:ignore:github-repositories-vulnerability-alerts
resource "github_repository" "default" {
allow_auto_merge = var.allow_auto_merge
allow_rebase_merge = var.allow_rebase_merge
allow_squash_merge = var.allow_squash_merge
archived = var.archived
auto_init = var.auto_init
delete_branch_on_merge = var.delete_branch_on_merge
description = var.description
gitignore_template = var.gitignore_template
has_downloads = var.has_downloads
has_issues = var.has_issues
has_projects = var.has_projects
has_wiki = var.has_wiki
homepage_url = var.homepage_url
is_template = var.is_template
name = var.name
visibility = var.visibility
vulnerability_alerts = var.vulnerability_alerts
allow_auto_merge = var.allow_auto_merge
allow_rebase_merge = var.allow_rebase_merge
allow_squash_merge = var.allow_squash_merge
archived = var.archived
auto_init = var.auto_init
delete_branch_on_merge = var.delete_branch_on_merge
description = var.description
gitignore_template = var.gitignore_template
has_downloads = var.has_downloads
has_issues = var.has_issues
has_projects = var.has_projects
has_wiki = var.has_wiki
homepage_url = var.homepage_url
is_template = var.is_template
name = var.name
squash_merge_commit_message = var.allow_squash_merge ? var.squash_merge_commit_message : null
squash_merge_commit_title = var.allow_squash_merge ? var.squash_merge_commit_title : null
visibility = var.visibility
vulnerability_alerts = var.vulnerability_alerts

dynamic "template" {
for_each = var.template_repository != null ? { create = true } : {}
Expand Down
22 changes: 22 additions & 0 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,28 @@ variable "repository_files" {
description = "A list of GitHub repository files that should be created"
}

variable "squash_merge_commit_message" {
type = string
default = "COMMIT_MESSAGES"
description = "The default commit message for squash merges"

validation {
condition = can(regex("^(PR_BODY|COMMIT_MESSAGES|BLANK)$", var.squash_merge_commit_message))
error_message = "The value of the variable 'squash_merge_commit_message' must be one of 'PR_BODY', 'COMMIT_MESSAGES' or 'BLANK'"
}
}

variable "squash_merge_commit_title" {
type = string
default = "COMMIT_OR_PR_TITLE"
description = "The default commit title for squash merges"

validation {
condition = can(regex("^(PR_TITLE|COMMIT_OR_PR_TITLE)$", var.squash_merge_commit_title))
error_message = "The value of the variable 'squash_merge_commit_title' must be one of 'PR_TITLE' or 'COMMIT_OR_PR_TITLE'"
}
}

variable "tag_protection" {
type = string
default = null
Expand Down