terraform-provider-github
terraform-provider-github copied to clipboard
[MAINT]: Deprecate `github_organization_custom_role` and replace with `github_organization_custom_repository_role` and `github_organization_custom_organization_role`
Describe the need
Following up on https://github.com/integrations/terraform-provider-github/issues/1069, it appears Github has decided to split custom roles out into two separate types now and was deprecated Sept 6, 2023 (see https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/custom-roles?apiVersion=2022-11-28#deprecated---create-a-custom-role).
The current implementation (https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_custom_role) I believe should be deprecated and replaced with the following:
Deprecated
- Resource:
github_organization_custom_role - Data source:
github_organization_custom_role
Replacement
API endpoints found here: https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/custom-roles?apiVersion=2022-11-28 Documentation: https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles go-github source: https://github.com/google/go-github/blob/master/github/orgs_custom_roles.go
- Resource:
github_organization_custom_repository_role - Data source:
github_organization_custom_repository_role
New
API endpoints found here: https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/organization-roles?apiVersion=2022-11-28 Documentation: https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles go-github source: (It looks like this is not supported yet)
- Resource:
github_organization_custom_organization_role - Data source:
github_organization_custom_organization_role
SDK Version
n/a
API Version
REST 2022-11-28
Relevant log output
No response
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Update: Organization custom role support was added to go-github in https://github.com/google/go-github/pull/3129 which got released in v63.
I think the custom role change is the only breaking change relevant for this project, the other breaking change being related to listing runners.
Should this issue be scoped at bumping the go-github package, fixing the custom role breaking API change and implementing the new resources as described?
When will this be added to the provider?
I would suggest that you don't need the custom part here and can use github_organization_role & github_organization_repository_role. I'm working on the former in 2487 and could potentially pick up the latter in the same PR.
👋 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!
Maybe you have some updates on this @stevehipwell ?
Sorry @brmb I have no additional information, th maintainer have been unresponsive for almost a year now.