[FEAT]: Add Support for GitHub Enterprise Rulesets by Ravio1i · Pull Request #3110 · integrations/terraform-provider-github

Ravio1i · 2026-01-22T14:07:23Z

Resolves #2666

Before the change?

No possibility to create or fetch rulesets at enterprise level

After the change?

Create rulesets with resource
Fetch rulesets with datasource

Pull request checklist

Schema migrations have been created if needed (example)
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

Notes

Tested with own GitHub Enterprise Cloud Instance
Currently there is a race condition in the test testAccGithubEnterpriseRuleset_required_workflows: Error running post-test destroy, there may be dangling resources for vulnerability-alerts`. The test still works but the vulnerabtily alert seems to be not finished in time. Happy to hear feedback about this

deiga

Initial pass. Not a complete review.

Please see if there are other parts of the PR where my comments might be applicable :)

github/resource_github_enterprise_ruleset.go

github/resource_github_enterprise_ruleset_test.go

deiga · 2026-01-23T11:56:57Z

You're doing good work!

I'm wondering if there are patterns from #2958 you should be copying here (for example the conditions and rules validation)

Ravio1i · 2026-01-23T13:14:59Z

You're doing good work!

Thanks! although I wasted a lot of time today being utterly confused of what is actually implemented and exposed in the API/golang sdk. E.g there are parts in the go sdk, which indicate that a ruleset can use the new repository_properties, organization_properties or merge_queue, but the actual API of the Enterprise Cloud is not supporting it 🔥

I'm wondering if there are patterns from #2958 you should be copying here (for example the conditions and rules validation)

I can check it out and see if I can adjust it !

#3110 (comment)

For the importer feature: I left it out intentionally as I was under the impression it is a feature used only in UI. Not sure who actually would use it with terraform/tofu to import json in hcl.

Ravio1i · 2026-01-23T14:24:43Z

I'm wondering if there are patterns from #2958 you should be copying here (for example the conditions and rules validation)

Similar to the the CustomizeDiff in #2958 I've added the util_ruleset_enterprise_validation.go to validate that:

ref_name is required for branch/tag, but forbidden for push/repository
creation, deletion, update, required_linear_history, required_signatures, pull_request, required_status_checks,
non_fast_forward, commit_message_pattern, commit_author_email_pattern, committer_email_pattern, branch_name_pattern,
tag_name_pattern, required_workflows, required_code_scanning, copilot_code_review rules are only valid for branch/tag
targets
file_path_restriction, max_file_size, max_file_path_length, file_extension_restriction rules are only valid for push
target
repository_creation, repository_deletion, repository_transfer, repository_name, repository_visibility rules are only
valid for repository target

deiga · 2026-01-23T14:50:26Z

The Importer is functionality to enable terraform import or the import block inside the config, so that existing resources can be added to state

Ravio1i · 2026-01-23T18:07:42Z

The Importer is functionality to enable terraform import or the import block inside the config, so that existing resources can be added to state

Oh nevermind, yes that I will most definitely add!

I thought you were referring to the importer functionality in GitHub rulesets. Oops

Ravio1i · 2026-01-26T09:27:10Z

The Importer is functionality to enable terraform import or the import block inside the config, so that existing resources can be added to state

7dd2b13

Added the importer functionality + test

TF_CLI_CONFIG_FILE=../dev.tfrc terraform import github_enterprise_ruleset.imported siemens:440187
github_enterprise_ruleset.imported: Importing from ID "siemens:440187"...
github_enterprise_ruleset.imported: Import prepared!
  Prepared github_enterprise_ruleset for import
github_enterprise_ruleset.imported: Refreshing state... [id=440187]

Import successful!

github/resource_github_enterprise_ruleset.go

github/util_ruleset_validation.go

stevehipwell

Thanks for the PR @Ravio1i.

examples/enterprise_rulesets/branch_rulesets.tf

github/data_source_github_enterprise_ruleset.go

github/data_source_github_enterprise_ruleset_test.go

github/resource_github_enterprise_ruleset.go

stevehipwell · 2026-02-16T17:25:36Z

github/util_rules.go

Please change the signature of this as the type isn't a bool.

The org bool parameter on expandConditions/flattenConditions/expandRules/flattenRules is a shared utility across all three resource types (repo, org, enterprise). It controls whether org-level fields (like organization_name, organization_id, repository_property) are included.

I agree, changing this to a more descriptive type (e.g. an enum like RulesetLevel) would be a good improvement but affects all three resource files and their tests. Should this be done as a separate refactoring PR to keep the scope of this PR focused?

It needs fixing in this PR as before this PR a bool can represent the supported states.

I addded RulesetLevel instad of the bool now

2a59f50

Please check if this is how you would do it or you want to handle it differently :)

github/data_source_github_enterprise_ruleset_test.go

github/data_source_github_enterprise_ruleset.go

github/resource_github_enterprise_ruleset.go

deiga · 2026-02-19T11:09:20Z

github/resource_github_enterprise_ruleset.go

+				Computed:    true,
+				Description: "GitHub ID for the ruleset.",
+			},
+			"conditions": {


Discussion: What if we split conditions into target_organizations and target_repositories or some similar naming? Similar to what it is like in the UI.

This could make the code for handling and validating these simpler and it could make the config UX clearer too.

@stevehipwell @nickfloyd thoughts?

I'd hold off on this for now.

deiga · 2026-02-19T11:14:34Z

github/resource_github_enterprise_ruleset.go

+					},
+				},
+			},
+			"rules": {


Discussion:
On the shoulders of https://github.com/integrations/terraform-provider-github/pull/3110/changes#r2827158611: What if we split the rules into separate lists based on which target they work with?

That would enable us to remove the rules validation for "is this target allowed to set this rule" and replace it with simpler built-in validators.
It would make the UX for our users nicer since they don't have to trial-and-error the rules.

@stevehipwell @nickfloyd thoughts?

I'd suggest opening an issue to discuss or creating a PR to demonstrate a POC.

github/resource_github_enterprise_ruleset.go

… and remove initial schemaversion

…e actor_type validation

…rise ruleset resource

…set tests

…se ruleset schema

…prise ruleset

…rprise ruleset

…ise ruleset schema

…ag, push, and repository targets

…ort and conditions

…te documentation

…n conditions and rules

… for enterprise ruleset

…itions and improve import error handling

…pand/flatten functions

… data source and improve test checks

…rove import handling

…equirements for repository rulesets

…ons with property validation

…dateDiagFunc for improved error handling

…nter types for target and source

… in data source

…nc with ConfigStateChecks using terraform-plugin-testing

…read function for improved type safety

github/data_source_github_enterprise_ruleset.go

github/resource_github_enterprise_ruleset.go

github/resource_github_enterprise_ruleset_test.go

… target attribute immutability

…ganization, and enterprise levels

…with shared HCL templates

github-actions bot added the Type: Feature New feature or request label Jan 22, 2026

Ravio1i mentioned this pull request Jan 22, 2026

[FEAT]: Add Support for GitHub Enterprise Rulesets #3108

Closed

5 tasks

deiga added the github_enterprise label Jan 22, 2026

deiga suggested changes Jan 22, 2026

View reviewed changes

Ravio1i changed the title ~~[FEAT]: Add Support for GitHub Enterprise Rulesets #3108~~ [FEAT]: Add Support for GitHub Enterprise Rulesets Jan 23, 2026

deiga added New data source New resource labels Jan 23, 2026

Ravio1i force-pushed the feat/enterprise-rulesets branch 2 times, most recently from f5a34a3 to dd26f68 Compare February 6, 2026 07:28

deiga suggested changes Feb 14, 2026

View reviewed changes

deiga approved these changes Feb 16, 2026

View reviewed changes

github/util_ruleset_validation.go Outdated Show resolved Hide resolved

deiga added this to the v6.12.0 Release milestone Feb 16, 2026

deiga requested a review from stevehipwell February 16, 2026 12:39

stevehipwell requested changes Feb 16, 2026

View reviewed changes

deiga suggested changes Feb 19, 2026

View reviewed changes

Ravio1i added 9 commits February 20, 2026 15:08

feat: add functionality and tests for GitHub Enterprise rulesets

dc77805

docs: GitHub enterprise ruleset data source and resource

e251233

refactor: simplify logging messages for enterprise ruleset operations…

9d8b390

… and remove initial schemaversion

feat: add description to GitHub enterprise ruleset resource and updat…

a30f1af

…e actor_type validation

chore: improve error handling for setting attributes in GitHub enterp…

44cbb56

…rise ruleset resource

refactor: streamline test check composition in GitHub enterprise rule…

2d03157

…set tests

fix: update conflicts handling for repository_name in GitHub enterpri…

09bc68d

…se ruleset schema

feat: add repository target rules and update handling in GitHub enter…

8d8bfea

…prise ruleset

feat: add organization_id condition support to GitHub enterprise ruleset

ee91775

Ravio1i added 19 commits February 20, 2026 15:08

feat: add merge queue and required deployments support to GitHub ente…

e2a870f

…rprise ruleset

feat: remove merge queue and required deployments from GitHub enterpr…

f0cdf67

…ise ruleset schema

docs: add examples for GitHub Enterprise rulesets including branch, t…

6ea80ea

…ag, push, and repository targets

feat: add customization validation for enterprise ruleset configuration

7aacee3

docs: enhance enterprise ruleset examples with repository target supp…

a3787e9

…ort and conditions

feat: add import functionality for GitHub enterprise ruleset and upda…

fda8d21

…te documentation

chore: upgrade go-github dependency to v82 and update context usage i…

686da11

…n conditions and rules

test: update test cases to use ProviderFactories instead of Providers…

07a8a49

… for enterprise ruleset

test: update flattenConditions tests to use context for organization_id

d5160d7

feat: enhance enterprise ruleset schema with repository property cond…

19f69db

…itions and improve import error handling

feat: add repository_property support in conditions validation and ex…

59d8167

…pand/flatten functions

feat: add example branch ruleset with repository property conditions

87f0adf

fix(enterprise_ruleset): add description to GitHub enterprise ruleset…

08cc9aa

… data source and improve test checks

refactor(enterprise_ruleset): streamline ruleset target types and imp…

cb73bdb

…rove import handling

refactor(ruleset): simplify validation logic and enhance conditions r…

3e7d102

…equirements for repository rulesets

test(enterprise_ruleset): add test for conflicting repository conditi…

3ac4706

…ons with property validation

refactor(enterprise_ruleset): update validation functions to use Vali…

e31eb8f

…dateDiagFunc for improved error handling

refactor(enterprise_ruleset): simplify resource creation by using poi…

dcdea85

…nter types for target and source

docs(enterprise_ruleset): clarify comment for repository target rules…

21d8823

… in data source

Ravio1i force-pushed the feat/enterprise-rulesets branch from b3dfcdd to 21d8823 Compare February 20, 2026 14:12

Ravio1i added 2 commits February 20, 2026 15:24

test(enterprise_ruleset): Replace deprecated Check/ComposeTestCheckFu…

ac5cbe3

…nc with ConfigStateChecks using terraform-plugin-testing

refactor(enterprise_ruleset): update ruleset ID handling in resource …

12f7413

…read function for improved type safety

deiga suggested changes Feb 23, 2026

View reviewed changes

Ravio1i added 3 commits February 24, 2026 09:21

refactor(enterprise_ruleset): improve ruleset ID handling and enforce…

4fa9e60

… target attribute immutability

refactor(ruleset): standardize ruleset handling across repository, or…

2a59f50

…ganization, and enterprise levels

test(enterprise_ruleset): restructure acceptance tests into subtests …

b613648

…with shared HCL templates

Comments

Conversation

Ravio1i commented Jan 22, 2026

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Notes

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deiga commented Jan 23, 2026

Uh oh!

Ravio1i commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ravio1i commented Jan 23, 2026

Uh oh!

deiga commented Jan 23, 2026

Uh oh!

Ravio1i commented Jan 23, 2026

Uh oh!

Ravio1i commented Jan 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ravio1i commented Jan 23, 2026 •

edited

Loading