Merge pull request #101 from mineiros-io/feature-auto-link-references

Add GitHub Autolink References configuration block

Author: mariux

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.0]
+
+### Added
+
+- Add GitHub Autolink References configuration block (thanks to @0x46616c6b)
+
 ## [0.12.0]
 
 ### BREAKING CHANGES
@@ -334,7 +340,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.12.0...HEAD
+[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.13.0...HEAD
+[0.13.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.12.0...v0.13.0
 [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
 [0.10.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.0...v0.10.1

README.md

@@ -31,6 +31,7 @@ _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terrafor
     - [Projects Configuration](#projects-configuration)
     - [Webhooks Configuration](#webhooks-configuration)
     - [Secrets Configuration](#secrets-configuration)
+    - [Autolink References Configuration](#autolink-references-configuration)
   - [Module Configuration](#module-configuration)
 - [Module Outputs](#module-outputs)
 - [External Documentation](#external-documentation)
@@ -82,7 +83,7 @@ Most basic usage creating a new private github repository.
 ```hcl
 module "repository" {
   source  = "mineiros-io/repository/github"
-  version = "~> 0.11.0"
+  version = "~> 0.13.0"
 
   name               = "terraform-github-repository"
   license_template   = "apache-2.0"
@@ -831,6 +832,24 @@ This is due to some terraform limitation and we will update the module once terr
   This requirement matches Github's API, see the upstream documentation for more information.
   Default is no approving reviews are required.
 
+#### Autolink References Configuration
+
+- [**`autolink_references`**](#var-autolink_references): *(Optional `list(autolink_reference)`)*<a name="var-autolink_references"></a>
+
+  This resource allows you to create and manage autolink references for GitHub repository.
+
+  Default is `[]`.
+
+  Each `autolink_reference` object in the list accepts the following attributes:
+
+  - [**`key_prefix`**](#attr-autolink_references-key_prefix): *(**Required** `string`)*<a name="attr-autolink_references-key_prefix"></a>
+
+    This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
+
+  - [**`target_url_template`**](#attr-autolink_references-target_url_template): *(**Required** `string`)*<a name="attr-autolink_references-target_url_template"></a>
+
+    The template of the target URL used for the links; must be a valid URL and contain `<num>` for the reference number.
+
 ### Module Configuration
 
 - [**`module_depends_on`**](#var-module_depends_on): *(Optional `list(any)`)*<a name="var-module_depends_on"></a>
@@ -911,6 +930,7 @@ The following attributes are exported by the module:
 - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_collaborator
 - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_deploy_key
 - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_project
+- https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_autolink_reference
 
 ## Module Versioning
 
@@ -970,6 +990,7 @@ Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
 [`github_repository_collaborator`]: https://www.terraform.io/docs/providers/github/r/repository_collaborator.html#attribute-reference
 [`github_repository_deploy_key`]: https://www.terraform.io/docs/providers/github/r/repository_deploy_key.html#attributes-reference
 [`github_repository_project`]: https://www.terraform.io/docs/providers/github/r/repository_project.html#attributes-reference
+[`github_repository_autolink_reference`]: https://www.terraform.io/docs/providers/github/r/repository_autolink_reference.html#attributes-reference
 [homepage]: https://mineiros.io/?ref=terraform-github-repository
 [hello@mineiros.io]: mailto:hello@mineiros.io
 [badge-build]: https://github.com/mineiros-io/terraform-github-repository/workflows/CI/CD%20Pipeline/badge.svg

README.tfdoc.hcl

@@ -89,7 +89,7 @@ section {
       ```hcl
       module "repository" {
         source  = "mineiros-io/repository/github"
-        version = "~> 0.11.0"
+        version = "~> 0.13.0"
 
         name               = "terraform-github-repository"
         license_template   = "apache-2.0"
@@ -1081,6 +1081,34 @@ section {
           END
         }
       }
+
+      section {
+        title = "Autolink References Configuration"
+
+        variable "autolink_references" {
+          type        = list(autolink_reference)
+          default     = []
+          description = <<-END
+              This resource allows you to create and manage autolink references for GitHub repository.
+            END
+
+          attribute "key_prefix" {
+            required    = true
+            type        = string
+            description = <<-END
+                This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
+              END
+          }
+
+          attribute "target_url_template" {
+            required    = true
+            type        = string
+            description = <<-END
+                The template of the target URL used for the links; must be a valid URL and contain `<num>` for the reference number.
+              END
+          }
+        }
+      }
     }
 
     section {
@@ -1209,6 +1237,7 @@ section {
         - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_collaborator
         - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_deploy_key
         - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_project
+        - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_autolink_reference
       END
     }
   }
@@ -1301,6 +1330,9 @@ references {
   ref "`github_repository_project`" {
     value = "https://www.terraform.io/docs/providers/github/r/repository_project.html#attributes-reference"
   }
+  ref "`github_repository_autolink_reference`" {
+    value = "https://www.terraform.io/docs/providers/github/r/repository_autolink_reference.html#attributes-reference"
+  }
   ref "homepage" {
     value = "https://mineiros.io/?ref=terraform-github-repository"
   }

examples/public-repository/README.md

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

examples/public-repository/main.tf

@@ -7,7 +7,7 @@
 
 module "repository" {
   source  = "mineiros-io/repository/github"
-  version = "~> 0.11.0"
+  version = "~> 0.13.0"
 
   module_depends_on = [
     module.team

main.tf

@@ -467,3 +467,21 @@ resource "github_actions_secret" "repository_secret" {
   secret_name     = each.key
   plaintext_value = each.value
 }
+
+# ---------------------------------------------------------------------------------------------------------------------
+# Autolink References
+# ---------------------------------------------------------------------------------------------------------------------
+
+locals {
+  autolink_references = { for i in var.autolink_references : lookup(i, "id", lower(i.key_prefix)) => merge({
+    target_url_template = null
+  }, i) }
+}
+
+resource "github_repository_autolink_reference" "repository_autolink_reference" {
+  for_each = local.autolink_references
+
+  repository          = github_repository.repository.name
+  key_prefix          = each.value.key_prefix
+  target_url_template = each.value.target_url_template
+}

test/unit-complete/main.tf

@@ -117,6 +117,8 @@ module "repository" {
   ]
 
   projects = var.projects
+
+  autolink_references = var.autolink_references
 }
 
 resource "github_branch" "development" {

test/unit-complete/variables.tf

@@ -230,3 +230,16 @@ variable "webhook_events" {
   type        = list(string)
   default     = ["issues"]
 }
+
+variable "autolink_references" {
+  description = "A list of autolink references"
+  type = list(object({
+    key_prefix          = string
+    target_url_template = string
+  }))
+
+  default = [{
+    key_prefix          = "TICKET-"
+    target_url_template = "https://hello.there/TICKET?query=<num>"
+  }]
+}

variables.tf

@@ -474,6 +474,24 @@ variable "plaintext_secrets" {
   default = {}
 }
 
+variable "autolink_references" {
+  description = "(Optional) Configuring autolink references. For details please check: https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_autolink_reference"
+  type = list(object({
+    key_prefix          = string
+    target_url_template = string
+  }))
+
+  # Example:
+  # autolink_references = [
+  #   {
+  #     key_prefix          = "TICKET-"
+  #     target_url_template = "https://hello.there/TICKET?query=<num>"
+  #   }
+  # ]
+
+  default = []
+}
+
 variable "vulnerability_alerts" {
   type        = bool
   description = "(Optional) Set to `false` to disable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level."