improve documentation for github_repository
#2265
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current
github_repository
documentation doesn't mention the fact that you may get an inconsistent Terraform plan also for the properties related toallow_merge_commit
andallow_squash_merge
. When a GitHub App fails to retrieve the state of the repository's settings through the GET method, it will always try to apply new changes ignoring the current values.Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!