From b9f5a199250f89085ecc0736b87437e488f0aca1 Mon Sep 17 00:00:00 2001 From: Nick Floyd Date: Mon, 20 Oct 2025 16:03:18 -0500 Subject: [PATCH] updates docs for PR #2488 --- website/docs/r/organization_ruleset.html.markdown | 11 +++++++++++ website/docs/r/repository_ruleset.html.markdown | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/website/docs/r/organization_ruleset.html.markdown b/website/docs/r/organization_ruleset.html.markdown index 1f31a19b42..3ce46b77aa 100644 --- a/website/docs/r/organization_ruleset.html.markdown +++ b/website/docs/r/organization_ruleset.html.markdown @@ -45,6 +45,15 @@ resource "github_organization_ruleset" "example" { operator = "starts_with" pattern = "ex" } + + required_workflows { + do_not_enforce_on_create = true + required_workflow { + repository_id = 1234 + path = ".github/workflows/ci.yml" + ref = "main" + } + } } } ``` @@ -163,6 +172,8 @@ The `rules` block supports the following: #### rules.required_workflows #### +* `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_workflow` - (Required) (Block Set, Min: 1) Actions workflows that are required. Multiple can be defined. (see [below for nested schema](#rules.required_workflows.required_workflow)) #### rules.required_workflows.required_workflow #### diff --git a/website/docs/r/repository_ruleset.html.markdown b/website/docs/r/repository_ruleset.html.markdown index 173ffcf234..dfb3420808 100644 --- a/website/docs/r/repository_ruleset.html.markdown +++ b/website/docs/r/repository_ruleset.html.markdown @@ -206,7 +206,7 @@ The `rules` block supports the following: #### rules.required_code_scanning #### -* `required_code_scanning_tool` - (Required) (Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see [below for nested schema](#rules.required_workflows.required_code_scanning_tool)) +* `required_code_scanning_tool` - (Required) (Block Set, Min: 1) Actions code scanning tools that are required. Multiple can be defined. (see [below for nested schema](#rules.required_code_scanning.required_code_scanning_tool)) #### rules.required_code_scanning.required_code_scanning_tool ####