Skip to content

docs: Adds do_not_enforce_on_create option for github_repository_ruleset docs #2667

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

Jump to bottom
Merged
merged 9 commits into from
Oct 23, 2025
Merged

docs: Adds do_not_enforce_on_create option for github_repository_ruleset docs #2667

merged 9 commits into from
Oct 23, 2025

Conversation

@nenosrep
Copy link
Contributor

Optional attribute added to rules.required_status_checks.
Resolves #2656

Before the change?

  • The option to allow repositories and branches to be created without enforcing status checks were prohibited by default, and would substitute the value of this configuration from the repo to always be false. It was not available for organization rulesets in the schema, which lead to a panic.

After the change?

  • Now it has the option to enable/disable enforce status checks on creation of a new branch/repo, manageable through the provider and without overwriting the configuration in the ruleset without being shown in terraform plan/apply.
  • Defining required checks will no longer result in a panic, as the schema now provides a default value instead of nil.

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

nenosrep added 3 commits May 22, 2025 07:26
@nenosrep
Add do_not_enforce_on_create option for github_organization_ruleset
7def010 
What: Expand schema with missing option do_not_enforce_on_create

Why: It is available for github_repository_ruleset and the API
@nenosrep
Add do_not_enforce_on_create to github_organization_ruleset test
672a0f5 
What: Expand test for github_organization_ruleset with
do_not_enforce_on_create

Why: To ensure that the do_not_enforce_on_create option is working
@nenosrep
Add do_not_enforce_on_create to github_organization_ruleset docs
d61737d 
What: Explain do_not_enforce_on_create option and default vaules in
the documentation for the github_organization_ruleset resource

Why: Keep the documentation consistent with the implementation
This was referenced May 22, 2025
Closed
Open
@nickfloyd nickfloyd moved this from 🆕 Triage to 👀 In review in 🧰 Octokit Active Jun 3, 2025
@anGie44
Copy link
Collaborator

anGie44 commented Jun 30, 2025

👋 Passerby note: #2545 provides a similar implementation

@nickfloyd nickfloyd moved this to On Deck in Terraform Provider Oct 14, 2025
@nickfloyd nickfloyd moved this from On Deck to In Progress in Terraform Provider Oct 20, 2025
@nickfloyd nickfloyd moved this from In Progress to In Review in Terraform Provider Oct 23, 2025
nickfloyd
nickfloyd reviewed Oct 23, 2025
View reviewed changes
nickfloyd
nickfloyd reviewed Oct 23, 2025
View reviewed changes
nickfloyd
nickfloyd reviewed Oct 23, 2025
View reviewed changes
nickfloyd
nickfloyd reviewed Oct 23, 2025
View reviewed changes
@nickfloyd nickfloyd changed the title Adds do_not_enforce_on_create option for github_repository_ruleset docs: Adds do_not_enforce_on_create option for github_repository_ruleset docs Oct 23, 2025
@nickfloyd
Copy link
Contributor

Previous change set covered the functional aspects of this change. Docs are the only thing we need now. ❤️

@nickfloyd nickfloyd merged commit d9f74b6 into integrations:main Oct 23, 2025
3 checks passed
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in 🧰 Octokit Active Oct 23, 2025
@github-project-automation github-project-automation bot moved this from In Review to Done in Terraform Provider Oct 23, 2025
@nenosrep nenosrep deleted the feat/2656 branch October 26, 2025 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nickfloyd nickfloyd nickfloyd approved these changes

Assignees

No one assigned

Labels

None yet

Projects

Terraform Provider
Status: Done

Milestone

Resolve Terraform integration Issues ...

Development

Successfully merging this pull request may close these issues.

[FEAT]: Implement do no enforce on create parameter for resource_github_organization_ruleset.go

3 participants

@nenosrep @anGie44 @nickfloyd