Permissions/compatibility for github_repository_autolink_reference and more

[mengesb]

Terraform Version

Terraform v1.0.11
on darwin_amd64
+ provider registry.terraform.io/integrations/github v4.18.0

Affected Resource(s)

• github_repository_autolink_reference
• Others ... see factoids

Terraform Configuration Files

locals {
    autolink = var.autolink_url == null ? {} : { for i in var.autolink : i => "${trimsuffix(var.autolink_url, "/")}/${i}-<num>" }
}

resource "github_repository_autolink_reference" "autolink" {
  for_each            = local.autolink
  repository          = github_repository.repository.name
  key_prefix          = "${each.key}-"
  target_url_template = each.value
}

Debug Output

│ Error: POST https://api.github.com/repos/${GITHUB_USER}/___repo___/autolinks: 404 Not Found []
│ 
│   with module.test_repo_github.github_repository_autolink_reference.autolink["TICKET"],
│   on modules/terraform-github-repository/main.tf line 66, in resource "github_repository_autolink_reference" "autolink":
│   66: resource "github_repository_autolink_reference" "autolink" {

Panic Output

N/A

Expected Behavior

More friendly message if possible - this was a permissions issue, not a 404 Not Found issue

Actual Behavior

HTTP/404 returned due to PAT not having all repo permissions

Steps to Reproduce

Please list the steps required to reproduce the issue, for example:

1. Create a personal access token without all repo permissions
2. terraform apply

Important Factoids

I'm unsure if this is possible, but there are a couple of improvements that would be nice.

In the event that the user specifies a base_url that isn't api.github.com, it likely means that the user is talking to a GHES system. Certain resources, namely this resource, isn't available until GHES 3.3. I'm not sure if there's an ability to report on compatibility along two things

• For each resource, list the relative permissions required
• For each resource, list the minimum GHES API and GH API version requirement? Perhaps the GH API version requirement isn't necessary, but in the case of GHES, this does matter.

References

• Feature request: Autolink references #285
• New resource github_repository_autolink_reference #924

[mengesb]

Unsure if this helps much for reference:

https://docs.github.com/en/[email protected]/rest/reference/meta#get-github-enterprise-server-meta-information

When I did for a data source was something to the effect of:

data "http" "GHES" {
  url = "https://${var.base_url}/api/v3/meta"

  request_headers = {
    Accept = "application/vnd.github.v3+json"
  }
}

output "ghes_version" {
  value = jsondecode(data.http.GHES.body).installed_version
}

This returns

~ $ terraform console
> module.test_repo_ghes.ghes_version
"2.22.6"

[github-actions]

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!

[github-actions]

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!