feat: Add build_type to github_repository (pages)

[0x46616c6b]

Resolves #1267

---

Behavior

Before the change?

• It is not possible to configure a GitHub Pages with GitHub Actions

After the change?

• The build_type option is added to pages property

---

Additional info

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes (Please add the Type: Breaking change label)
• No

Open Questions

• How can I ensure if the build_type = "legacy" that source is not optional anymore?
• This PR is related with feat: Split out Pages resource #1617, can it be introduced before the resource is split out?

[lukas-tide]

Looking forward to having this live

[lukas-tide]

@0x46616c6b to validate the field you could do the checks here

Validation functions are only supported for basic types, so the only option I have found is to do the checks on creation and update and in this case creation reuses update, so only update would work fine I guess. Maybe @kfcampbell could clarify if that is the case and if this is needed for the PR to get merged

[kfcampbell]

What happens if both source and build_type are present, which one takes precedence? What happens if legacy is set for build_type but source isn't set?

[0x46616c6b]

To be honest I am not aware what the GitHub API will return when the options are not set correctly. I can only outline the possible usage. Would like to prevent this with the Terraform validation but not sure if this is possible.

Allowed Options

resource "github_repository" "example" {
  name = "example"

  pages {
    source {
      branch = "main"
      path = "/"
    }
    build_type = "legacy"
  }
}

resource "github_repository" "example" {
  name = "example"

  pages {
    source {
      branch = "main"
      path = "/"
    }
  }
}

resource "github_repository" "example" {
  name = "example"

  pages {
    build_type = "workflow"
  }
}

Problematic / wrong Configuration

resource "github_repository" "example" {
  name = "example"

  pages {
    source {
      branch = "main"
      path = "/"
    }
    build_type = "workflow"
  }
}

[kfcampbell]

I'm okay with the validation approach; not running checks on creation/update should result in an error at the API level that will be passed back to the user in any case.

@0x46616c6b does this result in a breaking change for users? I'm not sure if providing "legacy" by default on all build_types results in any API-level changes or not.

[0x46616c6b]

I understand that upgrading the provider and applying the changes will cause a difference (in state only), but it won't affect the repository configuration. If this change is considered a breaking change (due to the new key changing the state), we should reflect that too.

[kfcampbell]

I'm okay with state changing as a non-breaking change as long as the API/GitHub state remains consistent. Thanks!

[benlangfeld]

This appears to have broken some use cases: #1724