integrations / terraform-provider-github

Terraform GitHub provider
https://www.terraform.io/docs/providers/github/
MIT License
887 stars 730 forks source link

docs: Clarify how allows_force_pushes works #2129

Closed bpaquet closed 7 months ago

bpaquet commented 7 months ago

Resolves #2054

2054 is not really a bug, it's more a documentation issue.

At graphql level, allowsForcePushes will be true only if everyone is allowed to bypass. If a list of bypasser is provided, allowsForcePushes will be false.

So in the terraform config, when force_push_bypassers is used, allowsForcePushes should be kept to `false.

This PR improves the doc and add a unit test.

I can add a validation on the config to block wrong configs when the two variables are not coherent, but it can broke some existing config.