feat : Support repository property for GitHub organization ruleset #2356

Moser-ss · 2024-08-20T18:46:52Z

Resolves #2137
Introduces the support to use repository_property to target repositories in the ruleset

The changes were manually tested against a GitHub Organization with an enterprise plan.
It is not possible to add properties with the source system because the lib version doesn't allow that. It is necessary to update to version v65

Before the change?

Cannot target ruleset using repository_property

After the change?

The ruleset can use the repository_property under the conditions block

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)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

Moser-ss · 2024-09-07T22:36:46Z

@kfcampbell, could you take a quick look to see if I need to improve anything in this PR

kfcampbell

Thanks! Have you looked at expanding the tests in github/resource_github_organization_ruleset_test.go to cover this usecase yet?

Moser-ss · 2024-09-13T17:48:17Z

A test case was added, I hope the change was not to ugly

Moser-ss · 2024-10-05T14:15:31Z

@kfcampbell can I do anything to speed up the review of this PR?

PaarthShah · 2024-10-16T00:15:34Z

github/resource_github_organization_ruleset.go

+													Elem: &schema.Schema{
+														Type: schema.TypeString,
+													},


Does this handle properties with boolean values? From a json export which shows the use of string "false" and "true" I assume it does

I manualy tested the solution and can handle boelean custom_properties using strings

stevehipwell · 2024-11-05T12:08:12Z

@Moser-ss I think you need to update the docs to reflect these changes?

Moser-ss · 2024-11-09T19:07:08Z

@stevehipwell Docs updated, thanks for catching that.

wrighbr · 2024-11-14T02:04:20Z

@PaarthShah @kfcampbell Would you have an estimate on when this PR might be reviewed and merged?

PaarthShah · 2024-11-14T03:53:57Z

@PaarthShah @kfcampbell Would you have an estimate on when this PR might be reviewed and merged?

@wrighbr No idea, I'm not a maintainer 😅

alexymantha · 2024-12-16T14:48:30Z

We also need this feature. It's been stale for a little while, anything we can do to get this merged?

daniddelrio · 2024-12-30T09:34:10Z

+1 on this PR. Would be great if this can get merged soon

ChrisStatham · 2025-01-07T18:38:12Z

@kfcampbell If you have a chance to review this feature it would be appreciated thanks!

aditya-nair1 · 2025-01-07T19:01:22Z

@kfcampbell +1, thanks!

vimc9 · 2025-01-07T19:56:43Z

@kfcampbell would be grateful for your review here 🚀 🚀 🚀

tayven-bigelow · 2025-01-27T19:19:54Z

@kfcampbell - Any chance of getting a review / approval of this PR?

graham1228 · 2025-03-14T15:35:15Z

➕ 1️⃣ on getting this merged. Would love to migrate our bash scripts to TF, but need this functionality.

lfraile · 2025-04-07T06:54:40Z

+1 On desperately needing this PR to get approved :(

tayven-bigelow · 2025-04-07T19:58:49Z

@kfcampbell - Is there any chance we could get this merged?
Is there something missing or any sort of directive as to why it hasn't been approved?

stevehipwell · 2025-04-08T11:16:53Z

@tayven-bigelow check out the commit history for this repo, I don't think GitHub are providing engineering resources here at the moment.

website/docs/r/organization_ruleset.html.markdown

loksonarius · 2025-05-19T21:05:17Z

tyvm for setting up this PR, I really hope it merges in soon 🙏

Maksym-Perehinets · 2025-11-14T21:49:25Z

hi, is there any chance to get this one merged?
+1

deiga · 2025-11-18T12:36:42Z

Hey there 👋

We're looking into getting this into a mergeable state :)

This PR will need to wait until #2891 is merged as the ruleset resources in the SDK have changed.

@Moser-ss Could you try rebasing and retargeting this branch to go-github-v68?

Moser-ss · 2025-11-18T16:19:58Z

@deiga, I already removed the conflicts by rebasing the branch with the main branch. But do you prefer that I rebase the branch using the branch go-github-v68

deiga · 2025-11-18T16:34:29Z

@Moser-ss nice! I think, you could try it locally, to see if anything breaks or needs changes.
If no, then you can leave it as is. With changes needed it could be better to rebase on that branch to be prepared for the changes needed

stevehipwell · 2025-11-18T18:00:02Z

@deiga @Moser-ss given that #2891 is using v77.0.0 that'd be the version to target, but I don't think there is much value in doing this independently of #2891 as the code will be modified as part of this work.

Moser-ss · 2025-12-05T10:17:45Z

@stevehipwell I tried to rebase my branch using the branch go-github-v68, but it starts to be a mess, because I have already made changes from the main branch that are not present in the go-github-v68, in particular the function flattenRules

So, do I wait for the changes of go-github-v68 to be in the main branch, or do I redo all my changes in a new branch from the branch go-github-v68

stevehipwell · 2025-12-05T10:27:20Z

@Moser-ss I'd hold off working on this until that branch (currently targeting v77) has been merged. I also know we're considering re-working the ruleset code for the v7 provider release.

Moser-ss · 2025-12-05T10:36:17Z

@stevehipwell Ok, if you need to spread the work with more people, you can count on me

deiga · 2026-01-17T19:09:01Z

@Moser-ss This can now be rebased and finalized! We managed to upgrade the SDK without a major release :)

Refactor expandConditions to reduce complexity Refactor logic to reduce the cognitive complexity and add logic to handle the repository_property field Flatten conditions for repository_property and fix schemas Add test case when ruleset use repository_property Refactor repository property conditions to make them optional Flatten update Target parameters to allow the detection of changes when remote resource is updated Update documentation

- Add ValidateFunc to include.source field for consistency with exclude - Update docs to mention repository_property as third targeting option - Fix missing space in documentation

Moser-ss · 2026-01-18T16:35:10Z

@deiga I just rebase with main branch

deiga · 2026-01-18T19:13:52Z

github/resource_github_organization_ruleset.go

+							ExactlyOneOf: []string{"conditions.0.repository_id", "conditions.0.repository_name"},
+							AtLeastOneOf: []string{"conditions.0.repository_id", "conditions.0.repository_name"},


issue: This isn't going to work as push rulesets don't work with any of these 😬

I have a PR almost ready to build the validation logic for rulesets which you can leverage: https://github.com/integrations/terraform-provider-github/pull/2958/changes#diff-89635a4e1dcb5319cdc31ace60e4b5854c13f237e5325009e4d9897288f9d3a0

I pushed a change that I hope matches the style of the validation we want to implement with CustomizeDiff.
I tested with my testing organization

stevehipwell · 2026-01-20T22:31:48Z

@Moser-ss I'm going to prioritise getting #2958 merged in before looking at other ruleset PRs, but as soon as that's in I'll revisit this.

Moser-ss marked this pull request as draft August 20, 2024 18:57

Moser-ss marked this pull request as ready for review August 20, 2024 22:58

Moser-ss force-pushed the Support-repository_property-for-github_organization_ruleset branch from bb62d7a to 40c5111 Compare August 28, 2024 13:17

Moser-ss changed the title ~~Support repository property for GitHub organization ruleset~~ feat : Support repository property for GitHub organization ruleset Sep 3, 2024

Moser-ss mentioned this pull request Sep 7, 2024

[FEAT]: Support targeting dynamic list by properties in organizational rulesets #2137

Open

1 task

kfcampbell reviewed Sep 13, 2024

View reviewed changes

PaarthShah reviewed Oct 16, 2024

View reviewed changes

dlaguerta mentioned this pull request Apr 28, 2025

[FEAT]: support organization level custom_property resource and custom_properties datasource #2642

Open

1 task

loksonarius reviewed May 19, 2025

View reviewed changes

website/docs/r/organization_ruleset.html.markdown Outdated Show resolved Hide resolved

loksonarius reviewed May 19, 2025

View reviewed changes

website/docs/r/organization_ruleset.html.markdown Outdated Show resolved Hide resolved

Moser-ss force-pushed the Support-repository_property-for-github_organization_ruleset branch from d30875f to 16c81f2 Compare November 18, 2025 16:04

nickfloyd added this to Terraform Provider Nov 20, 2025

github-project-automation bot moved this to Backlog in Terraform Provider Nov 20, 2025

nickfloyd moved this from Backlog to BLOCKED in Terraform Provider Nov 20, 2025

nickfloyd added this to the v7.0.0 Release milestone Nov 20, 2025

Moser-ss force-pushed the Support-repository_property-for-github_organization_ruleset branch from 46a7499 to 18674a6 Compare December 5, 2025 10:32

Moser-ss added 3 commits January 18, 2026 16:14

Apply format in the code base

e3be469

Fix repository_property validation and docs

0888d58

- Add ValidateFunc to include.source field for consistency with exclude - Update docs to mention repository_property as third targeting option - Fix missing space in documentation

Moser-ss force-pushed the Support-repository_property-for-github_organization_ruleset branch from 18674a6 to 0888d58 Compare January 18, 2026 16:34

deiga suggested changes Jan 18, 2026

View reviewed changes

github-project-automation bot moved this from 👀 In review to 🏗 In progress in 🧰 Octokit Active Jan 18, 2026

Support repository_property in push rulesets

d0e914b

stevehipwell modified the milestones: v7.0.0 Release, v6.11.0 Release Jan 20, 2026

deiga added the Type: Feature New feature or request label Jan 22, 2026

		ExactlyOneOf: []string{"conditions.0.repository_id", "conditions.0.repository_name"},
		AtLeastOneOf: []string{"conditions.0.repository_id", "conditions.0.repository_name"},

feat : Support repository property for GitHub organization ruleset #2356

Are you sure you want to change the base?

feat : Support repository property for GitHub organization ruleset #2356

Conversation

Moser-ss commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

Moser-ss commented Sep 7, 2024

Uh oh!

kfcampbell left a comment

Choose a reason for hiding this comment

Uh oh!

Moser-ss commented Sep 13, 2024

Uh oh!

Moser-ss commented Oct 5, 2024

Uh oh!

PaarthShah Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Moser-ss Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

stevehipwell commented Nov 5, 2024

Uh oh!

Moser-ss commented Nov 9, 2024

Uh oh!

wrighbr commented Nov 14, 2024

Uh oh!

PaarthShah commented Nov 14, 2024

Uh oh!

alexymantha commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daniddelrio commented Dec 30, 2024

Uh oh!

ChrisStatham commented Jan 7, 2025

Uh oh!

aditya-nair1 commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vimc9 commented Jan 7, 2025

Uh oh!

tayven-bigelow commented Jan 27, 2025

Uh oh!

graham1228 commented Mar 14, 2025

Uh oh!

lfraile commented Apr 7, 2025

Uh oh!

tayven-bigelow commented Apr 7, 2025

Uh oh!

stevehipwell commented Apr 8, 2025

Uh oh!

Uh oh!

Uh oh!

loksonarius commented May 19, 2025

Uh oh!

Maksym-Perehinets commented Nov 14, 2025

Uh oh!

deiga commented Nov 18, 2025

Uh oh!

Moser-ss commented Nov 18, 2025

Uh oh!

deiga commented Nov 18, 2025

Uh oh!

stevehipwell commented Nov 18, 2025

Uh oh!

Moser-ss commented Dec 5, 2025

Uh oh!

stevehipwell commented Dec 5, 2025

Uh oh!

Moser-ss commented Dec 5, 2025

Uh oh!

deiga commented Jan 17, 2026

Uh oh!

Moser-ss commented Jan 18, 2026

Moser-ss commented Aug 20, 2024 •

edited

Loading

PaarthShah Oct 16, 2024 •

edited

Loading

alexymantha commented Dec 16, 2024 •

edited

Loading

aditya-nair1 commented Jan 7, 2025 •

edited

Loading