Skip to content

feat : Support repository property for GitHub organization ruleset #2356

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
Moser-ss wants to merge 20 commits into
base: main
Choose a base branch
from
Open

feat : Support repository property for GitHub organization ruleset #2356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
cb37dbd
Define schema for repository_property
Moser-ss Aug 6, 2024
35bc82d
Apply format in the code base
Moser-ss Nov 18, 2025
49ab008
Fix repository_property validation and docs
Moser-ss Jan 18, 2026
e64d7db
Support repository_property in push rulesets
Moser-ss Jan 19, 2026
d83c9b6
Remove unused customdiff imports
Moser-ss Feb 4, 2026
b62cfdd
Replace custom validation with built-in ExactlyOneOf for repo targeting
Moser-ss Feb 13, 2026
5d32b3f
Rever unintencial change
Moser-ss Feb 13, 2026
c0333ba
Add tests, docs, and fix default handling for repository_property
Moser-ss Feb 13, 2026
59bb126
Apply suggestions from PR comment
Moser-ss Feb 14, 2026
c5085be
Add unit tests
Moser-ss Feb 14, 2026
a24d1d2
Remove redundant condition
Moser-ss Feb 17, 2026
121fb86
Updated description based in the GitHub API docs
Moser-ss Feb 17, 2026
309f8d3
Apply linter and fmt
Moser-ss Feb 17, 2026
1b97fb4
Remove unnecessary checks
Moser-ss Feb 17, 2026
968b1af
Remove tests
Moser-ss Feb 17, 2026
b33f177
Improve syntax for include and exclude property
Moser-ss Feb 17, 2026
3d68770
Use t context
Moser-ss Feb 23, 2026
24d2bcb
Rewrite tests using the resource_github_organization_custom_properties
Moser-ss Feb 23, 2026
6209daa
Refactor repository property names in organization ruleset tests for …
Moser-ss Feb 23, 2026
91298ad
Refactor tests to use state checks for repository property validation…
Moser-ss Feb 23, 2026
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
83 changes: 77 additions & 6 deletions github/resource_github_organization_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
Description: "Parameters for an organization ruleset condition. `ref_name` is required for `branch` and `tag` targets, but must not be set for `push` targets. One of `repository_name` or `repository_id` is always required.",
Description: "Parameters for an organization ruleset condition.The branch and tag rulesets conditions object should contain both repository_name and ref_name properties, or both repository_id and ref_name properties, or both repository_property and ref_name properties. The push rulesets conditions object does not require the ref_name property.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"ref_name": {
Expand Down Expand Up @@ -123,13 +123,83 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
},
},
},
"repository_property": {
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
ExactlyOneOf: []string{"conditions.0.repository_property", "conditions.0.repository_name", "conditions.0.repository_id"},
Description: "Conditions to target repositories by custom or system properties.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"include": {
Type: schema.TypeList,
Optional: true,
ConfigMode: schema.SchemaConfigModeAttr,
Description: "The repository properties and values to include. All of these properties must match for the condition to pass.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Required: true,
Description: "The name of the repository property to target.",
},
"property_values": {
Type: schema.TypeList,
Required: true,
Description: "The values to match for the repository property.",
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"source": {
Type: schema.TypeString,
Optional: true,
Description: "The source of the repository property. Defaults to 'custom' if not specified. Can be one of: custom, system",
Default: "custom",
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"custom", "system"}, false)),
},
},
},
},
"exclude": {
Type: schema.TypeList,
Optional: true,
ConfigMode: schema.SchemaConfigModeAttr,
Description: "The repository properties and values to exclude. The ruleset will not apply if any of these properties match.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Required: true,
Description: "The name of the repository property to target.",
},
"property_values": {
Type: schema.TypeList,
Required: true,
Description: "The values to match for the repository property.",
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"source": {
Type: schema.TypeString,
Optional: true,
Description: "The source of the repository property. Defaults to 'custom' if not specified. Can be one of: custom, system",
Default: "custom",
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"custom", "system"}, false)),
},
},
},
},
},
},
},
"repository_name": {
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
ExactlyOneOf: []string{"conditions.0.repository_property", "conditions.0.repository_name", "conditions.0.repository_id"},
Description: "Targets repositories that match the specified name patterns.",
ExactlyOneOf: []string{"conditions.0.repository_id"},
AtLeastOneOf: []string{"conditions.0.repository_id"},
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"include": {
Expand Down Expand Up @@ -158,9 +228,10 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
},
},
"repository_id": {
Type: schema.TypeList,
Optional: true,
Description: "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.",
Type: schema.TypeList,
Optional: true,
ExactlyOneOf: []string{"conditions.0.repository_property", "conditions.0.repository_name", "conditions.0.repository_id"},
Description: "The repository IDs that the ruleset applies to. One of these IDs must match for the ruleset to apply.",
Elem: &schema.Schema{
Type: schema.TypeInt,
},
Expand Down
Loading