terraform-provider-github icon indicating copy to clipboard operation
terraform-provider-github copied to clipboard

[BUG]: `group_description` in `github_team_sync_group_mapping` constantly recreated on change

Open akorp opened this issue 1 year ago • 3 comments

Expected Behavior

When a group_description is changed in IdPs (for example Azure Entra), the change in github_team_sync_group_mapping should persist on applying Terraform.

Actual Behavior

When a group_description is changed in IdPs (for example Azure Entra), terraform see the change and try to update the group block in github_team_sync_group_mapping. However the change with the new group_description does not persist. During next runs, terraform still shows the difference and constantly will try to update.

This could be related on how GitHub API handles updates to Identity Provider Groups. Some observation on similarity in GitHub GUI that might be relevant:

  • Change description of Azure Entra group which is connected to GitHub team.
  • Go to GitHub team setting Identity Provider Groups. Entra group will have the old description. If we try to remove the Entra group and add it again, the Entra group description will be updated, but the changes to the group description are not saved on pressing save. The group should be removed, saved and then added again to reflect the change to the description.

Terraform Version

Terraform 1.9.7 integrations/github v5.45.0

Affected Resource(s)

  • github_team_sync_group_mapping

Terraform Configuration Files

No response

Steps to Reproduce

No response

Debug Output

No response

Panic Output

No response

Code of Conduct

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

akorp avatar Oct 13 '24 09:10 akorp

I've also noticed that Entra group descriptions containing line breaks are constantly detected as changed (even on v6.5.0).

chris-pinola-rf avatar Jan 30 '25 18:01 chris-pinola-rf

👋 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[bot] avatar Dec 06 '25 02:12 github-actions[bot]

This sounds like the description would need to be set to ForceNew, if this is still happening

deiga avatar Dec 06 '25 16:12 deiga