Skip to content

fix: Add missed parameter to the github_organization_ruleset #2545

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

Merged
merged 4 commits into from
Oct 21, 2025
Merged

fix: Add missed parameter to the github_organization_ruleset #2545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1094ac8
Add missed parameter to the github_organization_ruleset
yurii-kysil Jan 23, 2025
eb3c14c
Update the markdown
yurii-kysil Apr 3, 2025
3fa3145
Merge branch 'main' into do_not_enforce_on_create
nickfloyd Oct 20, 2025
6b009e3
Merge branch 'main' into do_not_enforce_on_create
nickfloyd Oct 21, 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
6 changes: 6 additions & 0 deletions github/resource_github_organization_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,12 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
Optional: true,
Description: "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to `false`.",
},
"do_not_enforce_on_create": {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We actually also need it on the required_workflows struct too

terraform-provider-github/github/resource_github_organization_ruleset.go

Line 430 in eb3c14c

"required_workflows": {

Copy link
Collaborator

@anGie44 anGie44 Jun 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on the error you could prevent future panics in

terraform-provider-github/github/respository_rules_utils.go

Lines 343 to 348 in 9fceeda

doNotEnforceOnCreate := requiredStatusMap["do_not_enforce_on_create"].(bool)
params := &github.RequiredStatusChecksRuleParameters{
RequiredStatusChecks: requiredStatusChecks,
StrictRequiredStatusChecksPolicy: requiredStatusMap["strict_required_status_checks_policy"].(bool),
DoNotEnforceOnCreate: &doNotEnforceOnCreate,
}
as well by doing something like

		params := &github.RequiredStatusChecksRuleParameters{
			RequiredStatusChecks:             requiredStatusChecks,
		}

		if v, ok := requiredStatusMap["do_not_enforce_on_create"].(bool); ok {
			params.DoNotEnforceOnCreate =  &v
                }

                if v, ok := requiredStatusMap["strict_required_status_checks_policy"].(bool); ok {
                       params.StrictRequiredStatusChecksPolicy = v
                }

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(but the Default: false should prevent that from happening 😅 )

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the status on this?

Type: schema.TypeBool,
Optional: true,
Description: "Allow repositories and branches to be created if a check would otherwise prohibit it.",
Default: false,
},
},
},
},
Expand Down
2 changes: 2 additions & 0 deletions github/resource_github_organization_ruleset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ func TestGithubOrganizationRulesets(t *testing.T) {
}
strict_required_status_checks_policy = true
do_not_enforce_on_create = true
}
required_workflows {
Expand Down Expand Up @@ -251,6 +252,7 @@ func TestGithubOrganizationRulesets(t *testing.T) {
}
strict_required_status_checks_policy = true
do_not_enforce_on_create = true
}
branch_name_pattern {
Expand Down
2 changes: 2 additions & 0 deletions website/docs/r/organization_ruleset.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ The `rules` block supports the following:

* `strict_required_status_checks_policy` - (Optional) (Boolean) Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to `false`.

* `do_not_enforce_on_create` - (Optional) (Boolean) Allow repositories and branches to be created if a check would otherwise prohibit it. Defaults to `false`.

#### required_status_checks.required_check ####

* `context` - (Required) (String) The status check context name that must be present on the commit.
Expand Down
Loading