Skip to content

[BUG] github_organization_role Ensure role_id is set after Create #3011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deiga wants to merge 3 commits into
base: main
Choose a base branch
from
+27 −12
Open

[BUG] github_organization_role Ensure role_id is set after Create #3011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdd8675
Set `role_id` also in `resourceGithubOrganizationRoleCreate``
deiga Dec 18, 2025
d4c4649
API doesn't accept `base_role = none`
deiga Dec 18, 2025
e73ea1d
Revert unnecessary change
deiga Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions github/resource_github_organization_role.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,26 @@ func resourceGithubOrganizationRoleCreate(ctx context.Context, d *schema.Resourc
permissionsStr[i] = v.(string)
}

role, _, err := client.Organizations.CreateCustomOrgRole(ctx, orgName, &github.CreateOrUpdateOrgRoleOptions{
createOrUpdateOrgRoleOptions := &github.CreateOrUpdateOrgRoleOptions{
Name: github.String(d.Get("name").(string)),
Description: github.String(d.Get("description").(string)),
BaseRole: github.String(d.Get("base_role").(string)),
Permissions: permissionsStr,
})
}

baseRole := d.Get("base_role").(string)
if baseRole != "none" {
createOrUpdateOrgRoleOptions.BaseRole = github.String(baseRole)
}

role, _, err := client.Organizations.CreateCustomOrgRole(ctx, orgName, createOrUpdateOrgRoleOptions)
if err != nil {
return diag.FromErr(fmt.Errorf("error creating organization role (%s/%s): %w", orgName, d.Get("name").(string), err))
}

d.SetId(fmt.Sprint(role.GetID()))
if err = d.Set("role_id", role.GetID()); err != nil {
return diag.FromErr(err)
}
return nil
}

Expand Down Expand Up @@ -123,8 +132,14 @@ func resourceGithubOrganizationRoleRead(ctx context.Context, d *schema.ResourceD
if err = d.Set("description", role.Description); err != nil {
return diag.FromErr(err)
}
if err = d.Set("base_role", role.BaseRole); err != nil {
return diag.FromErr(err)
if role.BaseRole != nil {
if err = d.Set("base_role", role.BaseRole); err != nil {
return diag.FromErr(err)
}
} else {
if err = d.Set("base_role", "none"); err != nil {
return diag.FromErr(err)
}
}
if err = d.Set("permissions", role.Permissions); err != nil {
return diag.FromErr(err)
Expand Down
14 changes: 7 additions & 7 deletions github/resource_github_organization_role_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ func TestAccGithubOrganizationRole(t *testing.T) {
Steps: []resource.TestStep{
{
Config: config,
Check: resource.ComposeTestCheckFunc(
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttrSet("github_organization_role.test", "id"),
resource.TestCheckResourceAttrSet("github_organization_role.test", "role_id"),
resource.TestCheckResourceAttr("github_organization_role.test", "name", name),
resource.TestCheckResourceAttr("github_organization_role.test", "base_role", "none"),
resource.TestCheckResourceAttrSet("github_organization_role.test", "permissions.#"),
resource.TestCheckNoResourceAttr("github_organization_role.test", "permissions"),
resource.TestCheckResourceAttr("github_organization_role.test", "permissions.#", "0"),
),
},
Expand All @@ -57,11 +57,11 @@ func TestAccGithubOrganizationRole(t *testing.T) {
Steps: []resource.TestStep{
{
Config: config,
Check: resource.ComposeTestCheckFunc(
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttrSet("github_organization_role.test", "id"),
resource.TestCheckResourceAttr("github_organization_role.test", "name", name),
resource.TestCheckResourceAttr("github_organization_role.test", "base_role", baseRole),
resource.TestCheckResourceAttrSet("github_organization_role.test", "permissions.#"),
resource.TestCheckNoResourceAttr("github_organization_role.test", "permissions"),
resource.TestCheckResourceAttr("github_organization_role.test", "permissions.#", "0"),
),
},
Expand Down Expand Up @@ -167,16 +167,16 @@ func TestAccGithubOrganizationRole(t *testing.T) {
Steps: []resource.TestStep{
{
Config: config,
Check: resource.ComposeTestCheckFunc(
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttrSet("github_organization_role.test", "id"),
resource.TestCheckResourceAttrSet("github_organization_role.test", "role_id"),
resource.TestCheckResourceAttr("github_organization_role.test", "name", name),
resource.TestCheckResourceAttr("github_organization_role.test", "description", description),
resource.TestCheckResourceAttr("github_organization_role.test", "base_role", baseRole),
resource.TestCheckResourceAttrSet("github_organization_role.test", "permissions.#"),
resource.TestCheckResourceAttr("github_organization_role.test", "permissions.#", "2"),
resource.TestCheckResourceAttr("github_organization_role.test", "permissions.0", permission0),
resource.TestCheckResourceAttr("github_organization_role.test", "permissions.1", permission1),
resource.TestCheckTypeSetElemAttr("github_organization_role.test", "permissions.*", permission0),
resource.TestCheckTypeSetElemAttr("github_organization_role.test", "permissions.*", permission1),
),
},
},
Expand Down