repository_autolink_reference.html.markdown

layout	page_title	description
github	GitHub: github_repository_autolink_reference	Creates and manages autolink references for a single repository

github_repository_autolink_reference

This resource allows you to create and manage an autolink reference for a single repository.

Example Usage

resource "github_repository" "repo" {
  name         = "my-repo"
  description  = "GitHub repo managed by Terraform"

  private = false
}

resource "github_repository_autolink_reference" "autolink" {
  repository = github_repository.repo.name

  key_prefix = "TICKET-"

  target_url_template = "https://example.com/TICKET?query=<num>"
}

Argument Reference

The following arguments are supported:

• repository - (Required) The repository of the autolink reference.

• key_prefix - (Required) 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 - (Required) The template of the target URL used for the links; must be a valid URL and contain <num> for the reference number

• is_alphanumeric - (Optional) Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. Default is true.

Attributes Reference

The following additional attributes are exported:

• etag - An etag representing the autolink reference object.

Import

Autolink references can be imported using the name of the repository, combined with the id of the autolink reference and a / character for separating components, e.g.

terraform import github_repository_autolink_reference.auto my-repo/123

See the GitHub documentation for how to list all autolinks of a repository to learn the autolink ids to use with the import command.