Skip to content

[MAINT]: Deprecate github_organization_custom_role and replace with github_organization_custom_repository_role and github_organization_custom_organization_role #2224

@cailen

Description

@cailen

Describe the need

Following up on #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

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: Up for grabsIssues that are ready to be worked on by anyoneType: MaintenanceAny dependency, housekeeping, and clean up Issue or PR

    Type

    No type

    Projects

    Status

    ✅ Done

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions